Skip to content

test(record): pin zero through the wire format and the zone file #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Meldiron wants to merge 3 commits into from
Closed

test(record): pin zero through the wire format and the zone file #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d2c8de5
Fix soa zone answer
Meldiron Mar 26, 2026
f2851df
Fix tests
Meldiron Mar 26, 2026
c8c8a26
test(record): pin zero through the wire format and the zone file
Meldiron Sep 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions src/DNS/Zone/Resolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ public static function lookup(Message $query, Zone $zone): Message
$records = self::selectBestRecords($query, $zone);

if (empty($records)) {
// SOA is stored separately; if querying SOA at the zone apex, return it
if ($question->type === Record::TYPE_SOA && $question->name === $zone->name) {
return self::soaApexResponse($query, $zone);
}
Comment on lines +46 to +48

@greptile-apps greptile-apps Bot Sep 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Trailing dots miss SOA

A programmatically constructed apex SOA question such as example.com. keeps its trailing dot, while this new path requires exact string equality with the zone name. The query therefore falls through and returns NXDOMAIN or NODATA instead of the zone's SOA, leaving the apex SOA fix incomplete.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: src/DNS/Zone/Resolver.php
Line: 46-48

Comment:
**Trailing dots miss SOA**

A programmatically constructed apex SOA question such as `example.com.` keeps its trailing dot, while this new path requires exact string equality with the zone name. The query therefore falls through and returns NXDOMAIN or NODATA instead of the zone's SOA, leaving the apex SOA fix incomplete.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Fix in Claude Code Fix in Codex


return Message::response(
header: $query->header,
responseCode: Message::RCODE_NXDOMAIN,
Expand Down Expand Up @@ -157,6 +162,11 @@ private static function handleExactMatch(array $records, Message $query, Zone $z
$isAuthoritative = $zone->isAuthoritative($question->name);

if ($isAuthoritative) {
// SOA is stored separately in Zone; handle SOA queries at the zone apex
if ($question->type === Record::TYPE_SOA && $question->name === $zone->name) {
return self::soaApexResponse($query, $zone);
}

// Path E1: Exact match of type
$exactTypeRecords = array_filter(
$records,
Expand Down Expand Up @@ -215,6 +225,21 @@ private static function handleExactMatch(array $records, Message $query, Zone $z
}
}

/**
* Build an authoritative SOA answer for the zone apex.
*/
private static function soaApexResponse(Message $query, Zone $zone): Message
{
return Message::response(
header: $query->header,
responseCode: Message::RCODE_NOERROR,
questions: $query->questions,
answers: [$zone->soa],
authoritative: true,
Comment on lines +234 to +238

@greptile-apps greptile-apps Bot Sep 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 SOA shortcut ignores class

The new shortcut returns the zone's SOA without checking the question class. For example, a CH-class apex SOA question against an IN-class zone receives an authoritative IN record instead of no matching answer, violating the DNS question-class contract.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: src/DNS/Zone/Resolver.php
Line: 234-238

Comment:
**SOA shortcut ignores class**

The new shortcut returns the zone's SOA without checking the question class. For example, a CH-class apex SOA question against an IN-class zone receives an authoritative IN record instead of no matching answer, violating the DNS question-class contract.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Fix in Claude Code Fix in Codex

recursionAvailable: false
);
}

/**
* Randomize RRSet order for load balancing.
*
Expand Down
16 changes: 8 additions & 8 deletions tests/e2e/DNS/ClientTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,16 +213,16 @@ public function testSoaRecords(): void
$response = $client->query(Message::query(
new Question('appwrite.io', Record::TYPE_SOA)
));
$this->assertCount(0, $response->answers);
$this->assertCount(0, $response->authority);

$authority = $response->authority;
$this->assertCount(1, $authority);
$this->assertSame('appwrite.io', $authority[0]->name);
$this->assertSame(Record::CLASS_IN, $authority[0]->class);
$this->assertSame(30, $authority[0]->ttl);
$this->assertSame(Record::TYPE_SOA, $authority[0]->type);
$answers = $response->answers;
$this->assertCount(1, $answers);
$this->assertSame('appwrite.io', $answers[0]->name);
$this->assertSame(Record::CLASS_IN, $answers[0]->class);
$this->assertSame(30, $answers[0]->ttl);
$this->assertSame(Record::TYPE_SOA, $answers[0]->type);

$rdata = $authority[0]->rdata;
$rdata = $answers[0]->rdata;
$this->assertStringContainsString('ns1.appwrite.zone', $rdata);
$this->assertStringContainsString('team.appwrite.io', $rdata);
$this->assertStringContainsString('1 7200 1800 1209600 3600', $rdata);
Expand Down
95 changes: 95 additions & 0 deletions tests/unit/DNS/Message/RecordTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,101 @@ public function testDecodeSrvRecordParsesFields(): void
$this->assertSame(strlen($data), $offset);
}

public function testEncodeMxRecordWithZeroPriorityMatchesBytes(): void
{
// Zero is the highest priority a mail exchange can be given, and it is a value the
// sender chose, not a missing one. It has to reach the wire as two zero octets.
$record = new Record(
name: 'mail.example.com',
type: Record::TYPE_MX,
class: Record::CLASS_IN,
ttl: 3600,
rdata: 'mail.exchange.example.com',
priority: 0
);

// Raw RR: mail.example.com. 3600 IN MX 0 mail.exchange.example.com.
$expected = "\x04mail\x07example\x03com\x00"
. "\x00\x0F"
. "\x00\x01"
. "\x00\x00\x0E\x10"
. "\x00\x1D"
. "\x00\x00"
. "\x04mail\x08exchange\x07example\x03com\x00";

$this->assertSame($expected, $record->encode());
}

public function testDecodeMxRecordWithZeroPriorityParsesFields(): void
{
// Raw RR: mail.example.com. 3600 IN MX 0 mail.exchange.example.com.
$data = "\x04mail\x07example\x03com\x00"
. "\x00\x0F"
. "\x00\x01"
. "\x00\x00\x0E\x10"
. "\x00\x1D"
. "\x00\x00"
. "\x04mail\x08exchange\x07example\x03com\x00";

$offset = 0;
$record = Record::decode($data, $offset);

// A zero read off the wire has to stay a zero, not become the null that means "this
// record type carries no priority".
$this->assertSame(0, $record->priority);
$this->assertNotNull($record->priority);
$this->assertSame('mail.exchange.example.com', $record->rdata);
$this->assertSame(strlen($data), $offset);
}

public function testEncodeSrvRecordWithZeroNumericsMatchesBytes(): void
{
// RFC 2782 gives all three fields a meaning at zero: highest priority, no share of the
// weighted draw, and the port that marks the service as unavailable on this target.
$record = new Record(
name: '_sip._tcp.example.com',
type: Record::TYPE_SRV,
class: Record::CLASS_IN,
ttl: 7200,
rdata: 'sip.example.com',
priority: 0,
weight: 0,
port: 0
);

// Raw RR: _sip._tcp.example.com. 7200 IN SRV 0 0 0 sip.example.com.
$expected = "\x04_sip\x04_tcp\x07example\x03com\x00"
. "\x00\x21"
. "\x00\x01"
. "\x00\x00\x1C\x20"
. "\x00\x17"
. "\x00\x00\x00\x00\x00\x00"
. "\x03sip\x07example\x03com\x00";

$this->assertSame($expected, $record->encode());
}

public function testDecodeSrvRecordWithZeroNumericsParsesFields(): void
{
// Raw RR: _sip._tcp.example.com. 7200 IN SRV 0 0 0 sip.example.com.
$data = "\x04_sip\x04_tcp\x07example\x03com\x00"
. "\x00\x21"
. "\x00\x01"
. "\x00\x00\x1C\x20"
. "\x00\x17"
. "\x00\x00\x00\x00\x00\x00"
. "\x03sip\x07example\x03com\x00";

$offset = 0;
$record = Record::decode($data, $offset);

$this->assertSame(0, $record->priority);
$this->assertSame(0, $record->weight);
$this->assertSame(0, $record->port);
$this->assertSame('sip.example.com', $record->rdata);
$this->assertSame(strlen($data), $offset);
}

public function testEncodeTxtRecordMatchesBytes(): void
{
$record = new Record(
Expand Down
47 changes: 47 additions & 0 deletions tests/unit/DNS/Zone/FileTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,53 @@ public function testExportBasicZone(): void
$this->assertSame('mail.example.com', $roundTrip->records[2]->name);
}

public function testExportAndImportKeepZeroMxPriority(): void
{
// The zone file is the only thing a resolver reads. A priority of 0 written as an empty
// field, or dropped, does not just lose the priority: the line stops parsing, and an
// import failure takes every other record in the zone with it.
$zone = new Zone(
'example.com',
[
new Record('mail.example.com', Record::TYPE_MX, Record::CLASS_IN, 300, 'mail.example.com', priority: 0),
],
new Record('example.com', Record::TYPE_SOA, Record::CLASS_IN, 1800, 'ns1.example.com. admin.example.com. 2025011801 7200 3600 1209600 1800'),
);

$exported = File::export($zone, includeComments: false);
$this->assertStringContainsString("mail\t300\tIN\tMX\t0 mail\n", $exported);

$roundTrip = File::import($exported);
$record = $this->findRecord($roundTrip->records, Record::TYPE_MX);

$this->assertNotNull($record);
$this->assertSame(0, $record->priority);
$this->assertSame('mail.example.com', $record->rdata);
}

public function testExportAndImportKeepZeroSrvNumerics(): void
{
$zone = new Zone(
'example.com',
[
new Record('_sip._tcp.example.com', Record::TYPE_SRV, Record::CLASS_IN, 300, 'sip.example.com', priority: 0, weight: 0, port: 0),
],
new Record('example.com', Record::TYPE_SOA, Record::CLASS_IN, 1800, 'ns1.example.com. admin.example.com. 2025011801 7200 3600 1209600 1800'),
);

$exported = File::export($zone, includeComments: false);
$this->assertStringContainsString("_sip._tcp\t300\tIN\tSRV\t0 0 0 sip\n", $exported);

$roundTrip = File::import($exported);
$record = $this->findRecord($roundTrip->records, Record::TYPE_SRV);

$this->assertNotNull($record);
$this->assertSame(0, $record->priority);
$this->assertSame(0, $record->weight);
$this->assertSame(0, $record->port);
$this->assertSame('sip.example.com', $record->rdata);
}

public function testImportSupportsPtrRecords(): void
{
$soa = self::DEFAULT_SOA;
Expand Down
43 changes: 43 additions & 0 deletions tests/unit/DNS/Zone/ResolverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,49 @@ public function testLookupReturnsApexAAAARecord(): void
$this->assertSame($aaaaRecord, $response->answers[0]);
}

public function testLookupReturnsSoaAnswerForApexSoaQueryWithRecords(): void
{
$soa = new Record(
'example.com',
Record::TYPE_SOA,
ttl: 300,
rdata: 'ns1.appwrite.zone. team@appwrite.io. 1761705275 3600 600 86400 300'
);
$aRecord = new Record('example.com', Record::TYPE_A, ttl: 3600, rdata: '1.1.1.1');
$zone = new Zone('example.com', [$aRecord], $soa);

$question = new Question('example.com', Record::TYPE_SOA);
$query = Message::query($question);
$response = Resolver::lookup($query, $zone);

$this->assertSame(Message::RCODE_NOERROR, $response->header->responseCode);
$this->assertCount(1, $response->answers);
$this->assertSame($soa, $response->answers[0]);
$this->assertTrue($response->header->authoritative);
$this->assertFalse($response->header->recursionAvailable);
}

public function testLookupReturnsSoaAnswerForApexSoaQueryWithNoRecords(): void
{
$soa = new Record(
'example.com',
Record::TYPE_SOA,
ttl: 300,
rdata: 'ns1.appwrite.zone. team@appwrite.io. 1761705275 3600 600 86400 300'
);
$zone = new Zone('example.com', [], $soa);

$question = new Question('example.com', Record::TYPE_SOA);
$query = Message::query($question);
$response = Resolver::lookup($query, $zone);

$this->assertSame(Message::RCODE_NOERROR, $response->header->responseCode);
$this->assertCount(1, $response->answers);
$this->assertSame($soa, $response->answers[0]);
$this->assertTrue($response->header->authoritative);
$this->assertFalse($response->header->recursionAvailable);
}

public function testLookupReturnsSoaInAuthorityForApexNonNSQuery(): void
{
$soa = new Record(
Expand Down