Fix TypeError in _AllowedDomainNames.valid_name

[Copilot]

_AllowedDomainNames.valid_name raised a TypeError at runtime because it called ZoneError(domain_name=..., ...), but ZoneError.__init__ only accepts zone_name as its identifier parameter.

Context

ZoneError signature is __init__(self, zone_name: str, allowed_values: List[str]). Passing domain_name= as a keyword argument always fails with TypeError: unexpected keyword argument 'domain_name', making any invalid domain name produce a confusing secondary error instead of the intended validation message.

Change Summary

• Added DomainError(ValueError) class mirroring ZoneError but typed for domain context (domain_name parameter, "domain" error context string)
• Updated _AllowedDomainNames.valid_name to raise DomainError instead of ZoneError

# Before — raises TypeError
raise ZoneError(domain_name=domain_name, allowed_values=self())

# After — raises DomainError with correct message
raise DomainError(domain_name=domain_name, allowed_values=self())
# e.g. "'domain' has no attribute 'bad-domain'. The allowed values are: ['mixture']"

Rationale

Creating a dedicated DomainError is cleaner than patching ZoneError to accept both parameter names, keeps error types semantically distinct (callers can catch DomainError vs ZoneError independently), and matches the existing pattern used by InvalidSolutionVariableNameError.

Impact

_AllowedDomainNames.valid_name — previously always threw TypeError on an invalid domain name; now correctly raises DomainError with an informative message listing allowed domain names.

[codacy-production]

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

_{TIP This summary will be updated as you push new changes. Give us feedback}

[Copilot]

Pull request overview

This PR fixes runtime validation of invalid domain names in the solution variables service by replacing an incorrect ZoneError(domain_name=...) raise (which caused a TypeError) with a dedicated DomainError that formats the intended allowed-name message.

Changes:

• Introduced DomainError(ValueError) for invalid domain-name contexts.
• Updated _AllowedDomainNames.valid_name to raise DomainError instead of misusing ZoneError.
• Updated the corresponding docstring in _AllowedDomainNames.valid_name.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Consider adding a regression test for this behavior (e.g., calling SolutionVariableInfo.get_variables_info(..., domain_name="bad")) asserting that an invalid domain now raises DomainError (and that the message includes the allowed domain list). This would prevent the prior TypeError regression from reappearing.

[Gobot1234]

Closing this in favour of #5050