deeplink-parity 0.3.0 → 0.3.1

package/dist/cli.js

@@ -55,7 +55,17 @@ async function main() {
         return;
     }
     const source = wellKnown ? localSource(resolve(wellKnown)) : networkSource();
-    const result = await run({ roots, source, sha256 });
+    const result = await run({
+        roots,
+        source,
+        sha256,
+        onDiscovered: (count) => {
+            // some apps declare a domain per country; say so before spending minutes on it
+            if (!wellKnown && count > 50) {
+                console.error(`Checking ${count} domains — requests are pooled, so this will take a while.`);
+            }
+        },
+    });
     if (result.iosApps.length === 0 && result.androidApps.length === 0 && result.findings.length === 0) {
         console.error(`No app configuration declaring deep links was found in ${roots.join(', ')}`);
         console.error('Expected a .entitlements file with applinks:, or an AndroidManifest.xml with intent-filters.');

package/dist/fetch/wellKnown.js

@@ -1,6 +1,12 @@
 import { readFile } from 'node:fs/promises';
 import { join } from 'node:path';
 const TIMEOUT_MS = 10_000;
+/**
+ * Identify the tool to the hosts being read. An operator seeing these requests in a log
+ * should be able to tell what they are and who to ask, rather than finding an anonymous
+ * Node default.
+ */
+const USER_AGENT = 'deeplink-parity (+https://github.com/camosss/deeplink-parity)';
 export const AASA_FILE = 'apple-app-site-association';
 export const ASSETLINKS_FILE = 'assetlinks.json';
 export function aasaUrl(domain) {
@@ -20,7 +26,7 @@ async function fetchRaw(url) {
         const res = await fetch(url, {
             redirect: 'manual',
             signal: controller.signal,
-            headers: { accept: 'application/json' },
+            headers: { accept: 'application/json', 'user-agent': USER_AGENT },
         });
         const redirected = res.status >= 300 && res.status < 400;
         return {

package/dist/run.js

@@ -9,7 +9,7 @@ import { isWildcardDomain, wildcardFinding } from './rules/wildcard.js';
 function emptyView() {
     return { domains: new Set(), paths: new Map() };
 }
-export async function run({ roots, source, sha256 }) {
+export async function run({ roots, source, sha256, onDiscovered }) {
     const discovered = await Promise.all(roots.map(async (root) => Promise.all([discoverIos(root), discoverAndroid(root)])));
     const iosApps = discovered.flatMap(([ios]) => ios);
     const androidApps = discovered.flatMap(([, android]) => android);
@@ -21,6 +21,10 @@ export async function run({ roots, source, sha256 }) {
     }
     const ios = emptyView();
     const android = emptyView();
+    onDiscovered?.(new Set([
+        ...iosApps.flatMap((a) => a.domains),
+        ...androidApps.flatMap((a) => a.hosts.map((h) => h.host)),
+    ]).size);
     for (const app of iosApps) {
         // the same domain can be declared by several targets; fetch it once
         const fresh = app.domains.filter((d) => !ios.domains.has(d));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "deeplink-parity",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Checks that what your mobile app declares about deep links matches what is actually hosted — across iOS and Android.",
   "type": "module",
   "bin": {