279158 - nsIDNSRecord::canonicalName should document what it does for IDN

Status: RESOLVED FIXED

(Core :: Networking, defect, P3)

Description

[Christian :Biesinger (don't email me, ping me on IRC)]

52     /**
 53      * @return the canonical hostname for this record.  this value is empty if
 54      * the record was not fetched with the RESOLVE_CANONICAL_NAME flag.
 55      *
 56      * e.g., www.mozilla.org --> rheet.mozilla.org
 57      */
 58     readonly attribute ACString canonicalName;

It's unclear what will happen for IDN hostnames... probably it will return the
encoded name? (xn--...)

if it does, it would seem more useful if it returned the unicode version... but
it should at least document what it returns.

Comment 1

[Firefox Bug Husbandry Bot]

Bulk change to priority: https://bugzilla.mozilla.org/show_bug.cgi?id=1399258

Comment 2

[Firefox Bug Husbandry Bot]

Bulk change to priority: https://bugzilla.mozilla.org/show_bug.cgi?id=1399258

Comment 3

[Tan Yee Jian]

Hello! May I know how can I reproduce this bug or work on this bug?

Comment 4

[Sonakshi Saxena]

Hey [:valentin]
Is this bug still active?
If yes, then I would like to work on it.
Thanks!

Comment 5

[Valentin Gosu [:valentin] (he/him)]

I had to check what the call actually returns, so yes, it would be nice to clarify this in the docs.

We should add a comment here:
https://searchfox.org/mozilla-central/rev/72e3388f74458d369af4f6cdbaeaacb719523b8c/netwerk/dns/nsIDNSRecord.idl#34-36

That the result, if IDN will be returned as punycode.

eg., élève.w3c-test.org --> xn--lve-6lad.w3c-test.org

Also, a test would be nice to have. Something similar to this but for IDN domains.

Comment 6

[Sonakshi Saxena]

(In reply to Valentin Gosu [:valentin] (he/him) from comment #5)

Also, a test would be nice to have. Something similar to this but for IDN domains.
I read through the test that you shared, but I'm not sure if I understood it well enough. Can you point me out to a doc where I can read about the correct way to write unit tests?

Comment 7

[Valentin Gosu [:valentin] (he/him)]

https://developer.mozilla.org/en-US/docs/Mozilla/QA/Writing_xpcshell-based_unit_tests

Here is a doc regarding the test suite.
The steps for adding a new test are:

1. create the new file
2. add it to xpcshell.ini
3. write the test according to the doc - add_task(... check for things, etc.
4. test it with ./mach test path/to/test
5. submit patch

Comment 8

[Sonakshi Saxena]

Attachment: Bug 279158 - nsIDNSRecord::canonicalName should document what it does for IDN

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/ba2c085d9dff
nsIDNSRecord::canonicalName should document what it does for IDN r=valentin

Comment 10

[Natalia Csoregi [:nataliaCs]]

Backed out for failures on test_dns_service_wrap.js

backout: https://hg.mozilla.org/integration/autoland/rev/0cf45bcd47f5f266cae2c18ff0a13f1a366f2f00

push: https://treeherder.mozilla.org/#/jobs?repo=autoland&searchStr=xpcshell&revision=ba2c085d9dffb58aeaa8f91c29a7d8da241c45d3&selectedTaskRun=PgEakxWfQMey52DEV5GBkQ-0

failure log: https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=299812207&repo=autoland&lineNumber=9106

[task 2020-04-28T16:00:03.890Z] 16:00:03 INFO - TEST-START | netwerk/test/unit_ipc/test_dns_service_wrap.js
[task 2020-04-28T16:00:04.377Z] 16:00:04 WARNING - TEST-UNEXPECTED-FAIL | netwerk/test/unit_ipc/test_dns_service_wrap.js | xpcshell return code: 0
[task 2020-04-28T16:00:04.377Z] 16:00:04 INFO - TEST-INFO took 487ms
[task 2020-04-28T16:00:04.378Z] 16:00:04 INFO - >>>>>>>
[task 2020-04-28T16:00:04.378Z] 16:00:04 INFO - PID 5176 | Couldn't convert chrome URL: chrome://branding/locale/brand.properties
[task 2020-04-28T16:00:04.379Z] 16:00:04 INFO - PID 5176 | [5176, Main Thread] WARNING: Failed to get directory to cache.: file /builds/worker/checkouts/gecko/security/sandbox/win/src/sandboxbroker/sandboxBroker.cpp, line 88
[task 2020-04-28T16:00:04.379Z] 16:00:04 INFO - PID 5176 | [5176, Main Thread] WARNING: Failed to get directory to cache.: file /builds/worker/checkouts/gecko/security/sandbox/win/src/sandboxbroker/sandboxBroker.cpp, line 88
[task 2020-04-28T16:00:04.379Z] 16:00:04 INFO - PID 5176 | [5176, Main Thread] WARNING: Failed to get directory to cache.: file /builds/worker/checkouts/gecko/security/sandbox/win/src/sandboxbroker/sandboxBroker.cpp, line 88
[task 2020-04-28T16:00:04.380Z] 16:00:04 INFO - PID 5176 | [5176, Main Thread] WARNING: Failed to get directory to cache.: file /builds/worker/checkouts/gecko/security/sandbox/win/src/sandboxbroker/sandboxBroker.cpp, line 88
[task 2020-04-28T16:00:04.380Z] 16:00:04 INFO - PID 5176 | [5176, Main Thread] WARNING: Failed to get directory to cache.: file /builds/worker/checkouts/gecko/security/sandbox/win/src/sandboxbroker/sandboxBroker.cpp, line 88
[task 2020-04-28T16:00:04.381Z] 16:00:04 INFO - PID 5176 | [5176, Main Thread] WARNING: Couldn't get the user appdata directory. Crash events may not be produced.: file /builds/worker/checkouts/gecko/toolkit/crashreporter/nsExceptionHandler.cpp, line 2919
[task 2020-04-28T16:00:04.381Z] 16:00:04 INFO - (xpcshell/head.js) | test MAIN run_test pending (1)

Comment 11

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/f3fadee0347b
nsIDNSRecord::canonicalName should document what it does for IDN r=valentin

Comment 12

[Oana Pop-Rus]

https://hg.mozilla.org/mozilla-central/rev/f3fadee0347b