Files
cal.diy/packages/features/watchlist/lib/utils/normalization.test.ts
T
Alex van AndelandDevin AI c662a76277 feat: add configurable wildcard domain matching to watchlist (#27409)
* feat: add wildcard domain matching to watchlist

When a domain is blocked in the watchlist (e.g., cal.com), all subdomains
are now also blocked (e.g., app.cal.com, sub.app.cal.com).

Changes:
- Add getParentDomains() utility to extract all parent domains
- Update GlobalBlockingService.isBlocked() and areBlocked() for wildcard matching
- Update OrganizationBlockingService.isBlocked() and areBlocked() for wildcard matching
- Add comprehensive tests for wildcard domain matching
- More specific subdomain matches take precedence over parent domain matches
- Email matches still take precedence over domain matches

Co-Authored-By: alex@cal.com <me@alexvanandel.com>

* feat: make wildcard domain matching configurable

- *.cal.com blocks all subdomains (app.cal.com, sub.app.cal.com, etc.)
- cal.com only blocks exact matches (not subdomains)
- Updated getWildcardPatternsForDomain to generate wildcard patterns
- Added domainMatchesWatchlistEntry for configurable matching logic
- Updated GlobalBlockingService and OrganizationBlockingService
- Updated tests to verify new behavior

Co-Authored-By: alex@cal.com <me@alexvanandel.com>

* refactor: simplify wildcard pattern generation to strip only first part

- Only strips the first part before the first dot
- Handles multi-part TLDs correctly (e.g., .co.uk)
- Returns empty array for two-part domains (e.g., cal.com -> no pattern)
- app.cal.com -> *.cal.com
- bloody-hell.cal.co.uk -> *.cal.co.uk

Co-Authored-By: alex@cal.com <me@alexvanandel.com>

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-01-29 23:59:51 +00:00

154 lines
6.1 KiB
TypeScript

import { describe, expect, test } from "vitest";
import {
normalizeEmail,
normalizeDomain,
extractDomainFromEmail,
normalizeUsername,
getWildcardPatternsForDomain,
domainMatchesWatchlistEntry,
} from "./normalization";
describe("normalization", () => {
describe("normalizeEmail", () => {
test("should normalize basic email", () => {
expect(normalizeEmail("Test@Example.COM")).toBe("test@example.com");
expect(normalizeEmail(" user@domain.org ")).toBe("user@domain.org");
});
test("should throw on invalid emails", () => {
expect(() => normalizeEmail("invalid")).toThrow("Invalid email format");
expect(() => normalizeEmail("@domain.com")).toThrow("Invalid email format");
expect(() => normalizeEmail("user@")).toThrow("Invalid email format");
});
});
describe("normalizeDomain", () => {
test("should normalize basic domain", () => {
expect(normalizeDomain("Example.COM")).toBe("example.com");
expect(normalizeDomain("@Domain.ORG")).toBe("domain.org");
expect(normalizeDomain(" sub.domain.net ")).toBe("sub.domain.net");
});
test("should preserve full domain including subdomains", () => {
expect(normalizeDomain("mail.google.com")).toBe("mail.google.com");
expect(normalizeDomain("sub.domain.example.org")).toBe("sub.domain.example.org");
});
test("should handle multi-level TLDs correctly", () => {
expect(normalizeDomain("example.co.uk")).toBe("example.co.uk");
expect(normalizeDomain("mail.example.co.uk")).toBe("mail.example.co.uk");
expect(normalizeDomain("company.com.au")).toBe("company.com.au");
});
test("should throw on invalid domains", () => {
expect(() => normalizeDomain("invalid..domain")).toThrow("Invalid domain format");
expect(() => normalizeDomain(".domain.com")).toThrow("Invalid domain format");
expect(() => normalizeDomain("domain.")).toThrow("Invalid domain format");
});
});
describe("extractDomainFromEmail", () => {
test("should extract and normalize domain from email", () => {
expect(extractDomainFromEmail("user@Example.COM")).toBe("example.com");
expect(extractDomainFromEmail("test@sub.domain.org")).toBe("sub.domain.org");
expect(extractDomainFromEmail("user@mail.google.com")).toBe("mail.google.com");
});
test("should handle multi-level TLDs", () => {
expect(extractDomainFromEmail("user@example.co.uk")).toBe("example.co.uk");
expect(extractDomainFromEmail("admin@mail.company.com.au")).toBe("mail.company.com.au");
});
test("should throw on invalid emails", () => {
expect(() => extractDomainFromEmail("invalid")).toThrow("Invalid email format");
});
});
describe("normalizeUsername", () => {
test("should normalize basic username", () => {
expect(normalizeUsername("TestUser")).toBe("testuser");
expect(normalizeUsername(" user_name ")).toBe("user_name");
expect(normalizeUsername("User.Name-123")).toBe("user.name-123");
});
test("should preserve special characters", () => {
expect(normalizeUsername("user@name!")).toBe("user@name!");
expect(normalizeUsername("test.user-123")).toBe("test.user-123");
});
test("should throw on invalid usernames", () => {
expect(() => normalizeUsername("")).toThrow("Invalid username: must be a non-empty string");
});
});
describe("Edge cases and consistency", () => {
test("should handle international domains", () => {
// Note: In a real implementation, you might want to handle punycode
expect(normalizeDomain("münchen.de")).toBe("münchen.de");
});
test("should be consistent across multiple calls", () => {
const email = "Test.User+Tag@GMAIL.COM";
const result1 = normalizeEmail(email);
const result2 = normalizeEmail(email);
expect(result1).toBe(result2);
});
test("should handle empty strings gracefully", () => {
expect(() => normalizeEmail("")).toThrow();
expect(() => normalizeDomain("")).toThrow();
expect(() => normalizeUsername("")).toThrow();
});
});
describe("getWildcardPatternsForDomain", () => {
test("should return wildcard pattern for a subdomain", () => {
expect(getWildcardPatternsForDomain("app.cal.com")).toEqual(["*.cal.com"]);
});
test("should return single wildcard pattern for deeply nested subdomains", () => {
expect(getWildcardPatternsForDomain("sub.app.cal.com")).toEqual(["*.app.cal.com"]);
});
test("should return empty array for a simple domain (no subdomains)", () => {
expect(getWildcardPatternsForDomain("cal.com")).toEqual([]);
});
test("should handle multi-level TLDs correctly", () => {
expect(getWildcardPatternsForDomain("example.co.uk")).toEqual(["*.co.uk"]);
expect(getWildcardPatternsForDomain("bloody-hell.cal.co.uk")).toEqual(["*.cal.co.uk"]);
});
test("should return empty array for single-part domain", () => {
expect(getWildcardPatternsForDomain("localhost")).toEqual([]);
});
});
describe("domainMatchesWatchlistEntry", () => {
test("should match exact domain when no wildcard", () => {
expect(domainMatchesWatchlistEntry("cal.com", "cal.com")).toBe(true);
expect(domainMatchesWatchlistEntry("app.cal.com", "cal.com")).toBe(false);
});
test("should match subdomain when wildcard is used", () => {
expect(domainMatchesWatchlistEntry("app.cal.com", "*.cal.com")).toBe(true);
expect(domainMatchesWatchlistEntry("sub.app.cal.com", "*.cal.com")).toBe(true);
});
test("should not match exact domain with wildcard pattern", () => {
expect(domainMatchesWatchlistEntry("cal.com", "*.cal.com")).toBe(false);
});
test("should be case insensitive", () => {
expect(domainMatchesWatchlistEntry("APP.CAL.COM", "*.cal.com")).toBe(true);
expect(domainMatchesWatchlistEntry("app.cal.com", "*.CAL.COM")).toBe(true);
});
test("should not match unrelated domains", () => {
expect(domainMatchesWatchlistEntry("app.example.com", "*.cal.com")).toBe(false);
expect(domainMatchesWatchlistEntry("notcal.com", "cal.com")).toBe(false);
});
});
});