uptime-kuma/test/backend-test/test-domain.js
iotux e022b5f976
fix: allow for private domains like example.local and others (#6711)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Frank Elsinga <frank@elsinga.de>
2026-01-14 17:13:53 +00:00

332 lines
13 KiB
JavaScript

process.env.UPTIME_KUMA_HIDE_LOG = ["info_db", "info_server"].join(",");
const { describe, test, mock, before, after } = require("node:test");
const assert = require("node:assert");
const DomainExpiry = require("../../server/model/domain_expiry");
const mockWebhook = require("./notification-providers/mock-webhook");
const TestDB = require("../mock-testdb");
const { R } = require("redbean-node");
const { Notification } = require("../../server/notification");
const { Settings } = require("../../server/settings");
const { setSetting } = require("../../server/util-server");
const dayjs = require("dayjs");
dayjs.extend(require("dayjs/plugin/utc"));
const testDb = new TestDB();
describe("Domain Expiry", () => {
const monHttpCom = {
type: "http",
url: "https://www.google.com",
domainExpiryNotification: true,
};
before(async () => {
await testDb.create();
Notification.init();
});
after(async () => {
Settings.stopCacheCleaner();
await testDb.destroy();
});
test("getExpiryDate() returns correct expiry date for .wiki domain with no A record", async () => {
const d = DomainExpiry.createByName("google.wiki");
assert.deepEqual(await d.getExpiryDate(), new Date("2026-11-26T23:59:59.000Z"));
});
describe("checkSupport()", () => {
test("allows and correctly parses http monitor with valid domain", async () => {
const supportInfo = await DomainExpiry.checkSupport(monHttpCom);
let expected = {
domain: "google.com",
tld: "com",
};
assert.deepStrictEqual(supportInfo, expected);
});
describe("Target Validation", () => {
test("throws error for empty string target", async () => {
const monitor = {
type: "http",
url: "",
domainExpiryNotification: true,
};
await assert.rejects(
async () => await DomainExpiry.checkSupport(monitor),
(error) => {
assert.strictEqual(error.constructor.name, "TranslatableError");
assert.strictEqual(error.message, "domain_expiry_unsupported_missing_target");
return true;
}
);
});
test("throws error for undefined target", async () => {
const monitor = {
type: "http",
domainExpiryNotification: true,
};
await assert.rejects(
async () => await DomainExpiry.checkSupport(monitor),
(error) => {
assert.strictEqual(error.constructor.name, "TranslatableError");
assert.strictEqual(error.message, "domain_expiry_unsupported_missing_target");
return true;
}
);
});
test("throws error for null target", async () => {
const monitor = {
type: "http",
url: null,
domainExpiryNotification: true,
};
await assert.rejects(
async () => await DomainExpiry.checkSupport(monitor),
(error) => {
assert.strictEqual(error.constructor.name, "TranslatableError");
assert.strictEqual(error.message, "domain_expiry_unsupported_missing_target");
return true;
}
);
});
});
describe("Domain Parsing", () => {
test("throws error for IP address (isIp check)", async () => {
const monitor = {
type: "http",
url: "https://127.0.0.1",
domainExpiryNotification: true,
};
await assert.rejects(
async () => await DomainExpiry.checkSupport(monitor),
(error) => {
assert.strictEqual(error.constructor.name, "TranslatableError");
assert.strictEqual(error.message, "domain_expiry_unsupported_is_ip");
return true;
}
);
});
test("throws error for too short suffix(example.a)", async () => {
const monitor = {
type: "http",
url: "https://example.a",
domainExpiryNotification: true,
};
await assert.rejects(
async () => await DomainExpiry.checkSupport(monitor),
(error) => {
assert.strictEqual(error.constructor.name, "TranslatableError");
assert.strictEqual(error.message, "domain_expiry_public_suffix_too_short");
return true;
}
);
});
test("throws error for non-ICANN TLD (e.g. .local)", async () => {
const monitor = {
type: "http",
url: "https://example.local",
domainExpiryNotification: true,
};
await assert.rejects(
async () => await DomainExpiry.checkSupport(monitor),
(error) => {
assert.strictEqual(error.constructor.name, "TranslatableError");
assert.strictEqual(error.message, "domain_expiry_unsupported_is_icann");
return true;
}
);
});
});
describe("Edge Cases & RDAP Support", () => {
test("handles subdomain correctly", async () => {
const monitor = {
type: "http",
url: "https://api.staging.example.com/v1/users",
domainExpiryNotification: true,
};
const supportInfo = await DomainExpiry.checkSupport(monitor);
assert.strictEqual(supportInfo.domain, "example.com");
assert.strictEqual(supportInfo.tld, "com");
});
test("handles complex subdomain correctly", async () => {
const monitor = {
type: "http",
url: "https://mail.subdomain.example.org",
domainExpiryNotification: true,
};
const supportInfo = await DomainExpiry.checkSupport(monitor);
assert.strictEqual(supportInfo.domain, "example.org");
assert.strictEqual(supportInfo.tld, "org");
});
test("handles URL with port correctly", async () => {
const monitor = {
type: "http",
url: "https://example.com:8080/api",
domainExpiryNotification: true,
};
const supportInfo = await DomainExpiry.checkSupport(monitor);
assert.strictEqual(supportInfo.domain, "example.com");
assert.strictEqual(supportInfo.tld, "com");
});
test("handles URL with query parameters correctly", async () => {
const monitor = {
type: "http",
url: "https://example.com/search?q=test&page=1",
domainExpiryNotification: true,
};
const supportInfo = await DomainExpiry.checkSupport(monitor);
assert.strictEqual(supportInfo.domain, "example.com");
assert.strictEqual(supportInfo.tld, "com");
});
});
});
test("findByDomainNameOrCreate() retrieves expiration date for .com domain from RDAP", async () => {
const domain = await DomainExpiry.findByDomainNameOrCreate("google.com");
const expiryFromRdap = await domain.getExpiryDate(); // from RDAP
assert.deepEqual(expiryFromRdap, new Date("2028-09-14T04:00:00.000Z"));
});
test("checkExpiry() caches expiration date in database", async () => {
await DomainExpiry.checkExpiry("google.com"); // RDAP -> Cache
const domain = await DomainExpiry.findByName("google.com");
assert(dayjs.utc().diff(dayjs.utc(domain.lastCheck), "second") < 5);
});
test("sendNotifications() triggers notification for expiring domain", async () => {
await DomainExpiry.findByName("google.com");
const hook = {
port: 3010,
url: "capture",
};
const manyDays = 3650;
await setSetting("domainExpiryNotifyDays", [manyDays], "general");
const notif = R.convertToBean("notification", {
config: JSON.stringify({
type: "webhook",
httpMethod: "post",
webhookContentType: "json",
webhookURL: `http://127.0.0.1:${hook.port}/${hook.url}`,
}),
active: 1,
user_id: 1,
name: "Testhook",
});
const [, data] = await Promise.all([
DomainExpiry.sendNotifications("google.com", [notif]),
mockWebhook(hook.port, hook.url),
]);
assert.match(data.msg, /will expire in/);
});
test("sendNotifications() handles domain with null expiry without sending NaN", async () => {
// Regression test for bug: "Domain name will expire in NaN days"
// Mock findByDomainNameOrCreate to return a bean with null expiry
const mockDomain = {
domain: "test-null.com",
expiry: null,
lastExpiryNotificationSent: null,
};
mock.method(DomainExpiry, "findByDomainNameOrCreate", async () => mockDomain);
try {
const hook = {
port: 3012,
url: "should-not-be-called-null",
};
const notif = {
name: "TestNullExpiry",
config: JSON.stringify({
type: "webhook",
httpMethod: "post",
webhookContentType: "json",
webhookURL: `http://127.0.0.1:${hook.port}/${hook.url}`,
}),
};
// Race between sendNotifications and mockWebhook timeout
// If webhook is called, we fail. If it times out, we pass.
const result = await Promise.race([
DomainExpiry.sendNotifications("test-null.com", [notif]),
mockWebhook(hook.port, hook.url, 500)
.then(() => {
throw new Error("Webhook was called but should not have been for null expiry");
})
.catch((e) => {
if (e.reason === "Timeout") {
return "timeout"; // Expected - webhook was not called
}
throw e;
}),
]);
assert.ok(result === undefined || result === "timeout", "Should not send notification for null expiry");
} finally {
mock.restoreAll();
}
});
test("sendNotifications() handles domain with undefined expiry without sending NaN", async () => {
try {
// Mock findByDomainNameOrCreate to return a bean with undefined expiry (newly created bean scenario)
const mockDomain = {
domain: "test-undefined.com",
expiry: undefined,
lastExpiryNotificationSent: null,
};
mock.method(DomainExpiry, "findByDomainNameOrCreate", async () => mockDomain);
const hook = {
port: 3013,
url: "should-not-be-called-undefined",
};
const notif = {
name: "TestUndefinedExpiry",
config: JSON.stringify({
type: "webhook",
httpMethod: "post",
webhookContentType: "json",
webhookURL: `http://127.0.0.1:${hook.port}/${hook.url}`,
}),
};
// Race between sendNotifications and mockWebhook timeout
// If webhook is called, we fail. If it times out, we pass.
const result = await Promise.race([
DomainExpiry.sendNotifications("test-undefined.com", [notif]),
mockWebhook(hook.port, hook.url, 500)
.then(() => {
throw new Error("Webhook was called but should not have been for undefined expiry");
})
.catch((e) => {
if (e.reason === "Timeout") {
return "timeout"; // Expected - webhook was not called
}
throw e;
}),
]);
assert.ok(
result === undefined || result === "timeout",
"Should not send notification for undefined expiry"
);
} finally {
mock.restoreAll();
}
});
});