result messages can have a reference which is a URL

Author: gbicann

bin/rdap-validator

@@ -52,7 +52,7 @@ const MSG_FAIL          = "\x1b[1;31m✘\x1b[0m";
 const MSG_PASS          = "\x1b[1;32m✓\x1b[0m";
 const MSG_INFO          = "\x1b[1;33mi\x1b[0m";
 
-const cliResultCallback = function(result, message, path) {
+const cliResultCallback = function(result, message, path, ref) {
     const onlyErrors    = opt.named.hasOwnProperty("only-errors");
     const depth         = rdapValidator.path.length;
     const indent        = INDENT_STRING.repeat(onlyErrors ? 0 : Math.max(0, depth-1)) + "- ";
@@ -73,11 +73,12 @@ const cliResultCallback = function(result, message, path) {
     lastDepth = depth;
 };
 
-const jsonResultCallback = function(result, message, path) {
+const jsonResultCallback = function(result, message, path, ref) {
     jsonResultData.results.push({
         testPassed: result,
         message:    message,
         path:       path,
+        reference:  ref,
     });
 };
 

lib/rdap-validator.js

@@ -4,6 +4,24 @@ const self = rdapValidator;
 
 export default rdapValidator;
 
+self.referenceBase = "https://validator.rdap.org/specs/";
+
+self.referenceURLs = {
+    "rfc7480":      "vanilla/rfc7480.html",
+    "rfc7481":      "vanilla/rfc7481.html",
+    "rfc9082":      "vanilla/rfc9082.html",
+    "rfc9083":      "vanilla/rfc9083.html",
+    "rfc9224":      "vanilla/rfc9224.html",
+    "rfc9537":      "vanilla/rfc9537.html",
+    "feb24-rp":     "gtld/2024-02/rdap-response-profile-21feb24-en.pdf",
+    "feb24-tig":    "gtld/2024-02/rdap-technical-implementation-guide-21feb24-en.pdf",
+    "nro":          "rir/2021-01/nro-rdap-profile.txt",
+};
+
+self.ref = function(f, spec=null) {
+    return self.referenceBase + self.referenceURLs[spec ?? self.currentSpec] + "#" + f;
+}
+
 /**
  * Initiate a test run.
  * @param {null|string} url
@@ -12,6 +30,8 @@ export default rdapValidator;
  */
 self.testURL = function(url, type, serverType) {
 
+    self.currentSpec = "rfc7480";
+
     self.errors = 0;
 
     if (!self.responseTypes.hasOwnProperty(type)) {
@@ -83,22 +103,26 @@ self.testResponse = function(xhr, url, type, serverType) {
 
     if (!self.add(
         "error" == type ? xhr.status >= 400 : xhr.status < 400,
-        "HTTP status " + xhr.status + " MUST be " + ("error" == type ? "> 400 or higher" : "less than 400")
+        "HTTP status " + xhr.status + " MUST be " + ("error" == type ? "> 400 or higher" : "less than 400"),
+        "error" == type ? "section-5.3" : "section-5.1",
     )) return;
 
     if (!self.add(
         self.lastTestedResponseHeaders["content-type"].toLowerCase().startsWith("application/rdap+json"),
-        "Media type '" + self.lastTestedResponseHeaders["content-type"] + "' SHOULD be is application/rdap+json."
+        "Media type '" + self.lastTestedResponseHeaders["content-type"] + "' SHOULD be application/rdap+json.",
+        "section-4.2",
     )) return;
 
     var record;
 
+    self.currentSpec = "rfc9083";
+
     try {
       record = JSON.parse(xhr.response ?? xhr.responseText);
-      self.add(true, "Response body MUST be valid JSON.");
+      self.add(true, "Response body MUST be valid JSON.", "name-introduction");
 
     } catch (e) {
-      self.add(false, "Response body MUST be valid JSON (parse error: " + e + ").");
+      self.add(false, "Response body MUST be valid JSON (parse error: " + e + ").", "name-introduction");
 
       return;
     }
@@ -107,7 +131,8 @@ self.testResponse = function(xhr, url, type, serverType) {
 
     if (!self.add(
         self.isObject(record),
-        "Response body MUST be a JSON object."
+        "Response body MUST be a JSON object.",
+        "section-5",
     )) return;
 
     self.validateRDAPConformance(record);
@@ -219,16 +244,19 @@ self.validateRDAPConformance = function(record) {
 
     if (self.add(
         record.hasOwnProperty("rdapConformance"),
-        "Record MUST have the 'rdapConformance' property."
+        "Record MUST have the 'rdapConformance' property.",
+        "section-4.1",
     )) {
         self.add(
             self.isArray(record.rdapConformance),
-            "The 'rdapConformance' property MUST be an array."
+            "The 'rdapConformance' property MUST be an array.",
+            "section-4.1",
         );
 
         self.add(
             record.rdapConformance.indexOf("rdap_level_0") >= 0,
-            "The 'rdapConformance' property MUST contain 'rdap_level_0'."
+            "The 'rdapConformance' property MUST contain 'rdap_level_0'.",
+            "section-4.1",
         );
     }
 
@@ -2443,8 +2471,9 @@ self.countryCodes = [
  * @param {string} message
  * @param {mixed} context
  * @param {string} path
+ * @param {string} ref
  */
-self.resultCallback = (result, message, path) => null;
+self.resultCallback = (result, message, path, ref) => null;
 
 /**
  * Specify a callback to invoke when a result has been generated. This callback
@@ -2479,10 +2508,11 @@ self.setTestCompleteCallback = function(callback) {
  * Log a result by invoking the resultCallback with the provided arguments.
  * @param {bool} result
  * @param {string} message
+ * @param {string} ref
  */
-self.add = function(result, message) {
+self.add = function(result, message, ref) {
     if (false === result) self.errors++;
-    self.resultCallback(result, message, self.getPath());
+    self.resultCallback(result, message, self.getPath(), ref ? self.ref(ref) : undefined);
     return result;
 };
 

lib/spa.js

@@ -105,7 +105,7 @@ function scrollParentToChild(parent, child) {
 
 }
 
-rdapValidator.setResultCallback(function(result, message, path) {
+rdapValidator.setResultCallback(function(result, message, path, ref) {
 
     if (false !== result && document.getElementById("errors-only").checked) return;
 
@@ -115,9 +115,11 @@ rdapValidator.setResultCallback(function(result, message, path) {
 
     message = (null === result ? "ℹ️" : (true === result ? "✅" : "❌")) + message;
 
-    li.appendChild(document.createTextNode(message));
+    const msgspan = document.createElement("span");
+    msgspan.appendChild(document.createTextNode(message));
+    msgspan.title = path;
 
-    li.title = path;
+    li.appendChild(msgspan);
 
     if ("$" !== path) {
         li.addEventListener("click", function(event) {
@@ -146,6 +148,21 @@ rdapValidator.setResultCallback(function(result, message, path) {
 
         });
     }
+
+    if (ref) {
+        li.appendChild(document.createTextNode(" "));
+
+        const a = li.appendChild(document.createElement("a"));
+
+        a.appendChild(document.createTextNode("📖"));
+
+        a.setAttribute("href", ref);
+        a.setAttribute("target", "_blank");
+        a.setAttribute("title", "Open link to specification in a new window");
+
+        a.style.setProperty("vertical-align", "super");
+        a.style.setProperty("font-size", "small");
+    }
 });
 
 function JSONPathParent(path) {