@fedify/webfinger 2.2.13 → 2.2.14

package/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/webfinger",
-  "version": "2.2.13",
+  "version": "2.2.14",
   "license": "MIT",
   "exports": {
     ".": "./src/mod.ts"

package/dist/lookup.test.cjs

@@ -22,10 +22,12 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 }) : target, mod));
 //#endregion
 let _fedify_fixture = require("@fedify/fixture");
-let es_toolkit = require("es-toolkit");
-let node_assert_strict = require("node:assert/strict");
 let _fedify_vocab_runtime = require("@fedify/vocab-runtime");
 let _logtape_logtape = require("@logtape/logtape");
+let es_toolkit = require("es-toolkit");
+let node_assert_strict = require("node:assert/strict");
+let node_dns_promises = require("node:dns/promises");
+node_dns_promises = __toESM(node_dns_promises);
 let _opentelemetry_api = require("@opentelemetry/api");
 //#endregion
 //#region ../../node_modules/.pnpm/regexparam@3.0.0/node_modules/regexparam/dist/index.mjs
@@ -1228,7 +1230,7 @@ var esm_default = new class FetchMock {
 //#endregion
 //#region deno.json
 var name = "@fedify/webfinger";
-var version = "2.2.13";
+var version = "2.2.14";
 //#endregion
 //#region src/body.ts
 /** Decoded JSON body limit: 16 MiB.  @internal */
@@ -1364,7 +1366,11 @@ async function lookupWebFingerInternal(resource, options = {}) {
 			await (0, _fedify_vocab_runtime.validatePublicUrl)(url.href);
 		} catch (e) {
 			if (e instanceof _fedify_vocab_runtime.UrlError) {
-				logger.error("Invalid URL for WebFinger resource descriptor: {error}", { error: e });
+				if (e.reason === "dns") logger.debug("DNS lookup failed for {url}", {
+					url: url.href,
+					error: e
+				});
+				else logger.error("Invalid URL for WebFinger resource descriptor: {error}", { error: e });
 				return null;
 			}
 			throw e;
@@ -1609,4 +1615,42 @@ async function lookupWebFingerInternal(resource, options = {}) {
 		esm_default.hardReset();
 	}
 });
+(0, _fedify_fixture.test)("lookupWebFinger() logs DNS failures as such", async (t) => {
+	if ("Deno" in globalThis && (await Deno.permissions.query({ name: "net" })).state !== "granted") return;
+	for (const result of [
+		"throws",
+		"empty",
+		"private"
+	]) await t.step(result, async () => {
+		const originalLookup = node_dns_promises.default.lookup;
+		node_dns_promises.default.lookup = (() => result === "throws" ? Promise.reject(/* @__PURE__ */ new Error("Resolver unavailable")) : Promise.resolve(result === "empty" ? [] : [{
+			address: "127.0.0.1",
+			family: 4
+		}]));
+		const records = [];
+		await (0, _logtape_logtape.configure)({
+			sinks: { buffer: (record) => records.push(record) },
+			loggers: [{
+				category: "fedify",
+				sinks: ["buffer"],
+				lowestLevel: "debug"
+			}, {
+				category: ["logtape", "meta"],
+				sinks: []
+			}],
+			reset: true
+		});
+		try {
+			(0, node_assert_strict.deepStrictEqual)(await lookupWebFinger("acct:alice@dns-failure.invalid"), null);
+			const failures = records.filter((r) => r.rawMessage !== "Fetching WebFinger resource descriptor from {url}...");
+			(0, node_assert_strict.deepStrictEqual)(failures.map((r) => [r.level, r.rawMessage]), [result === "private" ? ["error", "Invalid URL for WebFinger resource descriptor: {error}"] : ["debug", "DNS lookup failed for {url}"]]);
+			const { error } = failures[0].properties;
+			(0, node_assert_strict.ok)(error instanceof _fedify_vocab_runtime.UrlError);
+			(0, node_assert_strict.deepStrictEqual)(error.reason, result === "private" ? "disallowed" : "dns");
+		} finally {
+			await (0, _logtape_logtape.reset)();
+			node_dns_promises.default.lookup = originalLookup;
+		}
+	});
+});
 //#endregion

package/dist/lookup.test.js

@@ -1,8 +1,9 @@
 import { test } from "@fedify/fixture";
-import { withTimeout } from "es-toolkit";
-import { deepStrictEqual } from "node:assert/strict";
 import { FetchError, UrlError, getUserAgent, validatePublicUrl } from "@fedify/vocab-runtime";
-import { getLogger } from "@logtape/logtape";
+import { configure, getLogger, reset } from "@logtape/logtape";
+import { withTimeout } from "es-toolkit";
+import { deepStrictEqual, ok } from "node:assert/strict";
+import dns from "node:dns/promises";
 import { SpanKind, SpanStatusCode, trace } from "@opentelemetry/api";
 //#region \0rolldown/runtime.js
 var __create = Object.create;
@@ -1227,7 +1228,7 @@ var esm_default = new class FetchMock {
 //#endregion
 //#region deno.json
 var name = "@fedify/webfinger";
-var version = "2.2.13";
+var version = "2.2.14";
 //#endregion
 //#region src/body.ts
 /** Decoded JSON body limit: 16 MiB.  @internal */
@@ -1363,7 +1364,11 @@ async function lookupWebFingerInternal(resource, options = {}) {
 			await validatePublicUrl(url.href);
 		} catch (e) {
 			if (e instanceof UrlError) {
-				logger.error("Invalid URL for WebFinger resource descriptor: {error}", { error: e });
+				if (e.reason === "dns") logger.debug("DNS lookup failed for {url}", {
+					url: url.href,
+					error: e
+				});
+				else logger.error("Invalid URL for WebFinger resource descriptor: {error}", { error: e });
 				return null;
 			}
 			throw e;
@@ -1608,5 +1613,43 @@ test("lookupWebFinger() bounds resource descriptors", async () => {
 		esm_default.hardReset();
 	}
 });
+test("lookupWebFinger() logs DNS failures as such", async (t) => {
+	if ("Deno" in globalThis && (await Deno.permissions.query({ name: "net" })).state !== "granted") return;
+	for (const result of [
+		"throws",
+		"empty",
+		"private"
+	]) await t.step(result, async () => {
+		const originalLookup = dns.lookup;
+		dns.lookup = (() => result === "throws" ? Promise.reject(/* @__PURE__ */ new Error("Resolver unavailable")) : Promise.resolve(result === "empty" ? [] : [{
+			address: "127.0.0.1",
+			family: 4
+		}]));
+		const records = [];
+		await configure({
+			sinks: { buffer: (record) => records.push(record) },
+			loggers: [{
+				category: "fedify",
+				sinks: ["buffer"],
+				lowestLevel: "debug"
+			}, {
+				category: ["logtape", "meta"],
+				sinks: []
+			}],
+			reset: true
+		});
+		try {
+			deepStrictEqual(await lookupWebFinger("acct:alice@dns-failure.invalid"), null);
+			const failures = records.filter((r) => r.rawMessage !== "Fetching WebFinger resource descriptor from {url}...");
+			deepStrictEqual(failures.map((r) => [r.level, r.rawMessage]), [result === "private" ? ["error", "Invalid URL for WebFinger resource descriptor: {error}"] : ["debug", "DNS lookup failed for {url}"]]);
+			const { error } = failures[0].properties;
+			ok(error instanceof UrlError);
+			deepStrictEqual(error.reason, result === "private" ? "disallowed" : "dns");
+		} finally {
+			await reset();
+			dns.lookup = originalLookup;
+		}
+	});
+});
 //#endregion
 export {};

package/dist/mod.cjs

@@ -4,7 +4,7 @@ let _logtape_logtape = require("@logtape/logtape");
 let _opentelemetry_api = require("@opentelemetry/api");
 //#region deno.json
 var name = "@fedify/webfinger";
-var version = "2.2.13";
+var version = "2.2.14";
 //#endregion
 //#region src/body.ts
 /** Decoded JSON body limit: 16 MiB.  @internal */
@@ -140,7 +140,11 @@ async function lookupWebFingerInternal(resource, options = {}) {
 			await (0, _fedify_vocab_runtime.validatePublicUrl)(url.href);
 		} catch (e) {
 			if (e instanceof _fedify_vocab_runtime.UrlError) {
-				logger.error("Invalid URL for WebFinger resource descriptor: {error}", { error: e });
+				if (e.reason === "dns") logger.debug("DNS lookup failed for {url}", {
+					url: url.href,
+					error: e
+				});
+				else logger.error("Invalid URL for WebFinger resource descriptor: {error}", { error: e });
 				return null;
 			}
 			throw e;

package/dist/mod.js

@@ -3,7 +3,7 @@ import { getLogger } from "@logtape/logtape";
 import { SpanKind, SpanStatusCode, trace } from "@opentelemetry/api";
 //#region deno.json
 var name = "@fedify/webfinger";
-var version = "2.2.13";
+var version = "2.2.14";
 //#endregion
 //#region src/body.ts
 /** Decoded JSON body limit: 16 MiB.  @internal */
@@ -139,7 +139,11 @@ async function lookupWebFingerInternal(resource, options = {}) {
 			await validatePublicUrl(url.href);
 		} catch (e) {
 			if (e instanceof UrlError) {
-				logger.error("Invalid URL for WebFinger resource descriptor: {error}", { error: e });
+				if (e.reason === "dns") logger.debug("DNS lookup failed for {url}", {
+					url: url.href,
+					error: e
+				});
+				else logger.error("Invalid URL for WebFinger resource descriptor: {error}", { error: e });
 				return null;
 			}
 			throw e;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/webfinger",
-  "version": "2.2.13",
+  "version": "2.2.14",
   "homepage": "https://fedify.dev/",
   "repository": {
     "type": "git",
@@ -60,7 +60,7 @@
     "@logtape/logtape": "^2.0.5",
     "@opentelemetry/api": "^1.9.0",
     "es-toolkit": "1.43.0",
-    "@fedify/vocab-runtime": "2.2.13"
+    "@fedify/vocab-runtime": "2.2.14"
   },
   "scripts": {
     "build:self": "tsdown",

package/src/lookup.test.ts

@@ -1,7 +1,10 @@
 import { test } from "@fedify/fixture";
+import { UrlError } from "@fedify/vocab-runtime";
+import { configure, type LogRecord, reset } from "@logtape/logtape";
 import { withTimeout } from "es-toolkit";
 import fetchMock from "fetch-mock";
-import { deepStrictEqual } from "node:assert/strict";
+import { deepStrictEqual, ok } from "node:assert/strict";
+import dns from "node:dns/promises";
 import type { ResourceDescriptor } from "./jrd.ts";
 import { lookupWebFinger } from "./lookup.ts";
 
@@ -365,3 +368,67 @@ test("lookupWebFinger() bounds resource descriptors", async () => {
     fetchMock.hardReset();
   }
 });
+
+test("lookupWebFinger() logs DNS failures as such", async (t) => {
+  // The validator skips DNS when Deno has no network permission.  Checked
+  // here rather than with top-level await, which the CommonJS build rejects.
+  if (
+    "Deno" in globalThis &&
+    (await Deno.permissions.query({ name: "net" })).state !== "granted"
+  ) return;
+  for (const result of ["throws", "empty", "private"] as const) {
+    await t.step(result, async () => {
+      // Stubbing works only because vocab-runtime's url.ts uses the default
+      // node:dns/promises import; see the FIXME there.
+      const originalLookup = dns.lookup;
+      dns.lookup = (() =>
+        result === "throws"
+          ? Promise.reject(new Error("Resolver unavailable"))
+          : Promise.resolve(
+            result === "empty" ? [] : [{ address: "127.0.0.1", family: 4 }],
+          )) as typeof dns.lookup;
+      const records: LogRecord[] = [];
+      await configure({
+        sinks: {
+          buffer: (record) =>
+            records.push(record),
+        },
+        loggers: [
+          { category: "fedify", sinks: ["buffer"], lowestLevel: "debug" },
+          { category: ["logtape", "meta"], sinks: [] },
+        ],
+        reset: true,
+      });
+      try {
+        deepStrictEqual(
+          await lookupWebFinger("acct:alice@dns-failure.invalid"),
+          null,
+        );
+        const failures = records.filter((r) =>
+          r.rawMessage !==
+            "Fetching WebFinger resource descriptor from {url}..."
+        );
+        deepStrictEqual(
+          failures.map((r) => [r.level, r.rawMessage]),
+          [
+            result === "private"
+              ? [
+                "error",
+                "Invalid URL for WebFinger resource descriptor: {error}",
+              ]
+              : ["debug", "DNS lookup failed for {url}"],
+          ],
+        );
+        const { error } = failures[0].properties;
+        ok(error instanceof UrlError);
+        deepStrictEqual(
+          error.reason,
+          result === "private" ? "disallowed" : "dns",
+        );
+      } finally {
+        await reset();
+        dns.lookup = originalLookup;
+      }
+    });
+  }
+});

package/src/lookup.ts

@@ -139,10 +139,20 @@ async function lookupWebFingerInternal(
         await validatePublicUrl(url.href);
       } catch (e) {
         if (e instanceof UrlError) {
-          logger.error(
-            "Invalid URL for WebFinger resource descriptor: {error}",
-            { error: e },
-          );
+          if (e.reason === "dns") {
+            logger.debug("DNS lookup failed for {url}", {
+              url: url.href,
+              error: e,
+            });
+          } else {
+            logger.error(
+              "Invalid URL for WebFinger resource descriptor: {error}",
+              { error: e },
+            );
+          }
+          // TODO: When merging forward into 2.3-maintenance and later, where
+          // this returns { resource: null, result: "network_error", remoteHost }
+          // instead of null, keep that return value for both reasons.
           return null;
         }
         throw e;