From e5959ca91daf38da9461417a88d1ca7079aca499 Mon Sep 17 00:00:00 2001 From: colinjtsen2010 Date: Tue, 11 Aug 2026 00:34:21 +0800 Subject: [PATCH] feat: add domain registration expiry monitoring Adds a GET /monitors/domain/:monitorId endpoint that looks up the registrable domain's WHOIS expiry date (walking up from subdomains), and displays it next to the certificate expiry on the uptime details page. Fixes #2094 --- .../Components/monitors/MonitorStatBoxes.tsx | 16 ++- client/src/Pages/Uptime/Details/index.tsx | 29 ++++ client/src/locales/en.json | 1 + client/src/locales/zh-CN.json | 1 + server/openapi.json | 125 ++++++++++++++++++ server/openapi/routes/monitor.ts | 11 ++ server/package-lock.json | 13 ++ server/package.json | 1 + server/src/api/controllers/controllerUtils.ts | 61 +++++++++ .../src/api/controllers/monitorController.ts | 21 ++- server/src/api/routes/monitorRoutes.ts | 3 + .../src/api/validation/monitorValidation.ts | 4 + server/test/unit/utils/domainExpiry.test.ts | 52 ++++++++ 13 files changed, 333 insertions(+), 5 deletions(-) create mode 100644 server/test/unit/utils/domainExpiry.test.ts diff --git a/client/src/Components/monitors/MonitorStatBoxes.tsx b/client/src/Components/monitors/MonitorStatBoxes.tsx index 58176dc04..8b201b474 100644 --- a/client/src/Components/monitors/MonitorStatBoxes.tsx +++ b/client/src/Components/monitors/MonitorStatBoxes.tsx @@ -11,12 +11,14 @@ interface MonitorStatBoxesProps { monitor?: Monitor; monitorStats: MonitorStats | null; certificateExpiry?: string; + domainExpiry?: string; } export const MonitorStatBoxes = ({ monitor, monitorStats, certificateExpiry, + domainExpiry, }: MonitorStatBoxesProps) => { const theme = useTheme(); const { t } = useTranslation(); @@ -66,10 +68,16 @@ export const MonitorStatBoxes = ({ /> {monitor?.type === "http" && ( - + <> + + + )} ); diff --git a/client/src/Pages/Uptime/Details/index.tsx b/client/src/Pages/Uptime/Details/index.tsx index 56724259a..bcf7177ac 100644 --- a/client/src/Pages/Uptime/Details/index.tsx +++ b/client/src/Pages/Uptime/Details/index.tsx @@ -38,6 +38,11 @@ interface CertificateResponse { certificateDate: string; } +interface DomainResponse { + domain: string; + expiryDate: string; +} + const UptimeDetailsPage = () => { const theme = useTheme(); const isAdmin = useIsAdmin(); @@ -102,6 +107,29 @@ const UptimeDetailsPage = () => { ); }, [certificateData, uiTimezone]); + // Domain expiry fetch - only for HTTP monitors + const domainUrl = useMemo(() => { + if (!monitorId || monitor?.type !== "http") { + return null; + } + return `/monitors/domain/${monitorId}`; + }, [monitorId, monitor?.type]); + + const { data: domainData } = useGet( + domainUrl, + {}, + { revalidateOnFocus: false } + ); + + const domainExpiry = useMemo(() => { + if (!domainData?.expiryDate) { + return undefined; + } + return ( + formatDateWithTz(domainData.expiryDate, certificateDateFormat, uiTimezone) ?? "N/A" + ); + }, [domainData, uiTimezone]); + const checksUrl = useMemo(() => { if (!monitorId || !monitor?.type) { return null; @@ -193,6 +221,7 @@ const UptimeDetailsPage = () => { monitor={monitor} monitorStats={monitorStats} certificateExpiry={certificateExpiry} + domainExpiry={domainExpiry} /> = 8" } }, + "node_modules/whoiser": { + "version": "1.18.0", + "resolved": "https://registry.npmmirror.com/whoiser/-/whoiser-1.18.0.tgz", + "integrity": "sha512-QRIGreBuouc8d9i+UVMFqYJSiG7gaoaGX8nKugYDGqnuNLLgjDBwmlKODOIGHveBawza3Kfkk/OuM9VsTUYwaA==", + "license": "MIT", + "dependencies": { + "punycode": "^2.1.1" + }, + "engines": { + "node": ">=15.0.0" + } + }, "node_modules/winston": { "version": "3.18.3", "resolved": "https://registry.npmjs.org/winston/-/winston-3.18.3.tgz", diff --git a/server/package.json b/server/package.json index e67bcdb78..f30495c5c 100755 --- a/server/package.json +++ b/server/package.json @@ -63,6 +63,7 @@ "sharp": "0.33.5", "ssl-checker": "2.0.10", "swagger-ui-express": "5.0.1", + "whoiser": "^1.18.0", "winston": "^3.13.0", "ws": "^8.19.0", "zod": "^4.3.6" diff --git a/server/src/api/controllers/controllerUtils.ts b/server/src/api/controllers/controllerUtils.ts index 1980ec0b4..7b014e656 100755 --- a/server/src/api/controllers/controllerUtils.ts +++ b/server/src/api/controllers/controllerUtils.ts @@ -2,7 +2,9 @@ import { AppError } from "@/utils/AppError.js"; import { Monitor, MonitorTypes, type MonitorType } from "@/domain/monitors/monitor.type.js"; import { UserRole } from "@/domain/users/user.type.js"; import sslChecker, { SSLDetails } from "ssl-checker"; +import * as whoiser from "whoiser"; type SSLCheckerType = typeof sslChecker; +type WhoisModule = typeof whoiser; export const fetchMonitorCertificate = async (checker: SSLCheckerType, monitor: Monitor): Promise => { const monitorUrl = new URL(monitor.url); @@ -13,6 +15,65 @@ export const fetchMonitorCertificate = async (checker: SSLCheckerType, monitor: } return cert; }; + +const WHOIS_TIMEOUT_MS = 10_000; +const EXPIRY_DATE_KEY_PATTERN = /(expiry date|expiration|paid-?till|registration expiration)/i; + +export const extractDomainExpiryDate = (whoisData: object): string | null => { + const matchingKey = Object.keys(whoisData).find((key) => EXPIRY_DATE_KEY_PATTERN.test(key)); + if (!matchingKey) { + return null; + } + const raw = extractString((whoisData as Record)[matchingKey] ?? null); + if (!raw) { + return null; + } + + const parsed = parseDomainExpiryValue(raw); + return parsed === null ? null : parsed.toISOString(); +}; + +const parseDomainExpiryValue = (raw: string): Date | null => { + // Some registries (e.g. Nominet for .uk) return "14-Feb-2027" style values. + const monthMatch = /^(\d{1,2})-([A-Za-z]{3})-(\d{4})$/.exec(raw.trim()); + if (monthMatch) { + const months = ["jan", "feb", "mar", "apr", "may", "jun", "jul", "aug", "sep", "oct", "nov", "dec"]; + const monthIndex = months.indexOf((monthMatch[2] ?? "").toLowerCase()); + if (monthIndex !== -1) { + const parsed = new Date(Date.UTC(Number(monthMatch[3]), monthIndex, Number(monthMatch[1]))); + if (!Number.isNaN(parsed.getTime())) { + return parsed; + } + } + } + + const date = new Date(raw); + if (!Number.isNaN(date.getTime())) { + return date; + } + return null; +}; + +export const fetchMonitorDomain = async (client: WhoisModule, monitor: Monitor): Promise<{ domain: string; expiryDate: string }> => { + const monitorUrl = new URL(monitor.url); + const labels = monitorUrl.hostname.split("."); + + // WHOIS registries only answer for the registrable domain, so try the full + // hostname first and walk up to the parent domain (www.example.com -> example.com). + for (let index = 0; index < labels.length - 1; index++) { + const candidate = labels.slice(index).join("."); + const result = await client.domain(candidate, { timeout: WHOIS_TIMEOUT_MS }); + const firstServerData = Object.values(result)[0]; + const expiryDate = extractDomainExpiryDate( + typeof firstServerData === "object" && firstServerData !== null && !Array.isArray(firstServerData) ? firstServerData : {} + ); + if (expiryDate) { + return { domain: candidate, expiryDate }; + } + } + throw new Error("Domain expiry not found"); +}; + export const requireString = (value: unknown, fieldName: string): string => { if (typeof value === "string" && value.trim().length > 0) { return value; diff --git a/server/src/api/controllers/monitorController.ts b/server/src/api/controllers/monitorController.ts index 664a78f45..4bd1a4fcb 100644 --- a/server/src/api/controllers/monitorController.ts +++ b/server/src/api/controllers/monitorController.ts @@ -10,6 +10,7 @@ import { editMonitorBodyValidation, pauseMonitorParamValidation, getCertificateParamValidation, + getDomainParamValidation, getHardwareDetailsByIdParamValidation, getHardwareDetailsByIdQueryValidation, getUptimeDetailsByIdParamValidation, @@ -18,13 +19,15 @@ import { bulkPauseMonitorBodyValidation, } from "@/api/validation/monitorValidation.js"; import sslChecker from "ssl-checker"; -import { fetchMonitorCertificate, requireTeamId, requireUserId } from "@/api/controllers/controllerUtils.js"; +import * as whoiser from "whoiser"; +import { fetchMonitorCertificate, fetchMonitorDomain, requireTeamId, requireUserId } from "@/api/controllers/controllerUtils.js"; import { AppError } from "@/utils/AppError.js"; import { IMonitorService } from "@/domain/monitors/monitor.service.js"; import { INotificationsService } from "@/domain/notifications/notification.service.js"; export interface IMonitorController { getMonitorCertificate: RequestHandler; + getMonitorDomain: RequestHandler; getUptimeDetailsById: RequestHandler; getHardwareDetailsById: RequestHandler; getPageSpeedDetailsById: RequestHandler; @@ -68,6 +71,22 @@ class MonitorController implements IMonitorController { }); }); + getMonitorDomain = catchAsync(async (req: Request, res: Response) => { + const validatedParams = getDomainParamValidation.parse(req.params); + const teamId = requireTeamId(req.user?.teamId); + const monitor = await this.monitorService.getMonitorById({ teamId, monitorId: validatedParams.monitorId }); + const domainExpiry = await fetchMonitorDomain(whoiser, monitor); + + return res.status(200).json({ + success: true, + msg: "Domain expiry retrieved successfully", + data: { + domain: domainExpiry.domain, + expiryDate: new Date(domainExpiry.expiryDate), + }, + }); + }); + getUptimeDetailsById = catchAsync(async (req: Request, res: Response) => { const validatedParams = getUptimeDetailsByIdParamValidation.parse(req.params); const validatedQuery = getUptimeDetailsByIdQueryValidation.parse(req.query); diff --git a/server/src/api/routes/monitorRoutes.ts b/server/src/api/routes/monitorRoutes.ts index 43a94b5c4..4cd90a9a0 100644 --- a/server/src/api/routes/monitorRoutes.ts +++ b/server/src/api/routes/monitorRoutes.ts @@ -29,6 +29,9 @@ export const createMonitorRoutes = (monitorController: IMonitorController): Rout router.get("/certificate/:monitorId", (req, res, next) => { monitorController.getMonitorCertificate(req, res, next); }); + router.get("/domain/:monitorId", (req, res, next) => { + monitorController.getMonitorDomain(req, res, next); + }); // General monitor CRUD routes router.patch("/notifications", isAllowed(["admin", "superadmin"]), monitorController.updateNotifications); diff --git a/server/src/api/validation/monitorValidation.ts b/server/src/api/validation/monitorValidation.ts index 441809c42..d8b23a8e3 100644 --- a/server/src/api/validation/monitorValidation.ts +++ b/server/src/api/validation/monitorValidation.ts @@ -52,6 +52,10 @@ export const getCertificateParamValidation = z.object({ monitorId: z.string().min(1, "Monitor ID is required"), }); +export const getDomainParamValidation = z.object({ + monitorId: z.string().min(1, "Monitor ID is required"), +}); + const refineDnsHostname = (body: { type?: string; url?: string }, ctx: z.RefinementCtx) => { if (body.type === "dns" && body.url && !dnsHostnameRegex.test(body.url)) { ctx.addIssue({ diff --git a/server/test/unit/utils/domainExpiry.test.ts b/server/test/unit/utils/domainExpiry.test.ts new file mode 100644 index 000000000..7d6e02e49 --- /dev/null +++ b/server/test/unit/utils/domainExpiry.test.ts @@ -0,0 +1,52 @@ +import { describe, expect, it } from "@jest/globals"; +import { extractDomainExpiryDate, fetchMonitorDomain } from "../../../src/api/controllers/controllerUtils.ts"; +import type { Monitor } from "../../../src/domain/monitors/monitor.type.ts"; + +const makeMonitor = (url: string): Monitor => + ({ + url, + type: "http", + }) as unknown as Monitor; + +describe("extractDomainExpiryDate", () => { + it("returns an ISO date for ISO registry expiry values", () => { + expect(extractDomainExpiryDate({ "Registry Expiry Date": "2027-08-13T04:00:00Z" })).toBe("2027-08-13T04:00:00.000Z"); + }); + + it("returns an ISO date for dd-MMM-yyyy expiry values", () => { + expect(extractDomainExpiryDate({ "Expiry Date": "14-Feb-2027" })).toBe("2027-02-14T00:00:00.000Z"); + }); + + it("returns null when no expiry key exists", () => { + expect(extractDomainExpiryDate({ "Domain Name": "example.com" })).toBeNull(); + }); + + it("returns null when the expiry value cannot be parsed", () => { + expect(extractDomainExpiryDate({ "Expiry Date": "not-a-date" })).toBeNull(); + }); +}); + +describe("fetchMonitorDomain", () => { + it("walks up from the hostname to the registrable domain", async () => { + const queried: string[] = []; + const client = { + domain: async (domain: string) => { + queried.push(domain); + return domain === "example.com" ? { "whois.verisign-grs.com": { "Expiry Date": "2027-08-13T04:00:00Z" } } : {}; + }, + }; + + const result = await fetchMonitorDomain(client as never, makeMonitor("https://www.example.com")); + + expect(queried).toEqual(["www.example.com", "example.com"]); + expect(result).toEqual({ domain: "example.com", expiryDate: "2027-08-13T04:00:00.000Z" }); + }); + + it("throws when no candidate has an expiry date", async () => { + const client = { + domain: async () => ({ "whois.verisign-grs.com": { "Domain Name": "example.com" } }), + }; + + await expect(fetchMonitorDomain(client as never, makeMonitor("https://example.com"))).rejects.toThrow("Domain expiry not found"); + }); +});