Minor changes to Zone11 msgids#1264
Conversation
| Z11_SPF1_MULTIPLE_RECORDS | ERROR | ns_ip_list | The following name servers returned more than one SPF policy. Name servers: {ns_ip_list}. | ||
| Z11_SPF1_SYNTAX_ERROR | ERROR | ns_ip_list | The zone’s SPF policy has a syntax error. Policy retrieved from the following nameservers: {ns_ip_list}. | ||
| Z11_SPF1_SYNTAX_OK | INFO | | The zone’s SPF 1 policy has correct syntax. |
There was a problem hiding this comment.
If the version is omitted in the message id, would it make sense to rename the message tags too in that regard?
e.g. Z11_SPF1_SYNTAX_OK to Z11_SPF_SYNTAX_OK (and others)
This might not be worth the hassle, though. I'm fine with either.
There was a problem hiding this comment.
Renaming the message tags will be too disruptive, in my opinion. I suggest we leave them be.
Bring the msgids closer to what would be implemented in Engine.
efd218e to
29694a3
Compare
| Z11_SPF1_SYNTAX_ERROR | ERROR | ns_ip_list | The zone’s SPF policy has a syntax error. Policy retrieved from the following nameservers: {ns_ip_list}. | ||
| Z11_SPF1_SYNTAX_OK | INFO | | The zone’s SPF policy has correct syntax. | ||
| Z11_UNABLE_TO_CHECK_FOR_SPF | ERROR | | None of the zone’s name servers responded with an authoritative response to queries for SPF policies. |
There was a problem hiding this comment.
To be strict, the policy is a feature of a name (mail domain) not a zone. In a zone you could have multiple SPF policies for different mail domains, can't you. E.g. in the zone test.xa you could have one for afnic.test.xa and another for iis.test.xa given that those are used for mail addresses, e.g. info@afnic.test.xa and info@iis.test.xa, respectively. Zonemaster only tests the SPF policy of the mail domain equal to the zone apex, but that is still just a name.
I suggest something like "The SPF policy of the zone apex (...)"
(I also put the same comment in zonemaster/zonemaster-engine#1348 (review))
There was a problem hiding this comment.
Or maybe something like "The SPF policy of {domain} has (...)" where "{domain}" is the name of apex. It will probably be easier to understand than my first suggestion,
There was a problem hiding this comment.
I’ll do that. However, adding the {domain} argument will require a database migration script in order not to break existing messages, because they do not have any arguments.
There was a problem hiding this comment.
This is something that we have not considered in the past, but it is not irrelevant. However, if we have that requirement it will be hard to update the messages in the future. When we remove a tag (or rename) it will affect even more.
There was a problem hiding this comment.
Yes, database migrations are annoying, but I have another PR open that could use a similar script for the same reason. We could piggyback on that one if we want.
Technically, any domain, not just zones, can have SPF policies.
Zonemaster will only fetch the domain under test’s SPF policy. This
means that language referring to “the zone’s SPF policy” is technically
incorrect.
This commit updates the following messages tags to remove such language:
* Z11_INCONSISTENT_SPF_POLICIES;
* Z11_NO_SPF_FOUND;
* Z11_SPF1_SYNTAX_ERROR;
* Z11_SPF1_SYNTAX_OK.
The three last tags in the list get a new argument, {domain}, which is
necessary for the msgid to stay meaningful and user-friendly. The
alternative would be to say something like “the SPF policy at the zone’s
apex”, but “the SPF policy at domain.example” is much better. This is,
however, a change that should ideally be addressed by a database
migration script so that old tests stay meaningful.
|
I’ve changed a few more msgids to completely remove language such as “the zone’s SPF policy” in the messages this test case generates. @matsduf, what do you think about the new messages? |
|
Implemented in zonemaster/zonemaster-engine#1348 |
Purpose
This PR brings the msgids defined in the specification for Zone11 closer to what would be implemented in Engine.
Context
See zonemaster/zonemaster-engine#1328.
Changes
Slight changes to the msgids in Zone11.
How to test this PR
Not applicable.