@houtini/seo-audit-console 0.7.8 → 0.8.0

package/dist/server.js

@@ -8,7 +8,8 @@ import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { z } from 'zod';
 import { getDashboardData } from './core/dashboardData.js';
-import { startDashboardServer, stopDashboardServer, dashboardServerUrl, listLocalProperties } from './core/webServer.js';
+import { startDashboardServer, stopDashboardServer, dashboardServerUrl } from './core/webServer.js';
+import { buildWebCallHandlers } from './core/webHandlers.js';
 import { computeSerpFootprint, persistSerpFootprint } from './core/serpFootprint.js';
 import { computeMarketSizing, persistMarketSizing } from './core/marketSizing.js';
 import { FirecrawlClient } from './core/FirecrawlClient.js';
@@ -291,6 +292,28 @@ export function createServer() {
     // (Links, Content research) and their affiliate-linked upsell states. The data layer has
     // no env access, so it's injected here onto every dashboard payload surface.
     const apiKeysStatus = () => ({ dataforseo: !!dfs, majestic: !!majestic, firecrawl: !!firecrawl, supadata: !!supadata });
+    // The dashboard webserver's options — one definition shared by serve_dashboard AND the
+    // auto-start at the end of refresh_property / run_audit, so a populated property always has
+    // a live browser link (browserLink() surfaces dashboardServerUrl() once this is running).
+    const buildWebOpts = (port) => ({
+        dataDir,
+        uiHtml: () => readFileSync(path.join(__dirname, 'src', 'ui', 'dashboard.html'), 'utf8'),
+        call: buildWebCallHandlers({ dataDir, dfs, apiKeys: apiKeysStatus }),
+        ...(port != null ? { port } : {}),
+    });
+    // Idempotent auto-start used by refresh_property / run_audit. Best-effort: a served port that
+    // can't bind (e.g. Docker without a published port) must never fail the populate/audit — the
+    // in-chat get_dashboard and export_report still work, and browserLink() falls back to those.
+    // Opt-out with SAC_AUTOSERVE=0 for headless/CI/sandboxed runs where binding a localhost port
+    // is unwanted (default: on, since the whole point is to hand the user a link).
+    const autoServeDashboard = async () => {
+        if (/^(0|false|no|off)$/i.test(process.env.SAC_AUTOSERVE ?? ''))
+            return;
+        try {
+            await startDashboardServer(buildWebOpts());
+        }
+        catch { /* dashboard is a convenience, not a dependency */ }
+    };
     // ── Introspection (no data / creds required) ────────────────────────────
     server.registerTool('seo_audit_help', {
         title: 'Help — what this audit can do',
@@ -414,9 +437,10 @@ export function createServer() {
         },
     }, async ({ siteUrl, scope, categories, includeJudgement }) => {
         const result = runAudit(dataDir(), siteUrl, { scope, categories, includeJudgement });
+        await autoServeDashboard(); // spin up the browser dashboard so browserLink() hands over a live URL
         return {
             content: [{ type: 'text', text: buildAuditMarkdown(result, siteUrl) + browserLink(siteUrl) }],
-            structuredContent: result,
+            structuredContent: { ...result, dashboardUrl: dashboardServerUrl() },
         };
     });
     server.registerTool('query_audit', {
@@ -730,7 +754,14 @@ export function createServer() {
         },
         _meta: { ui: { resourceUri: SYNC_PROGRESS_URI } },
     }, async ({ siteUrl, gsc: doGsc, crawl, inspect, ranks, segments, full, location, startDate, endDate, maxPages, inspectLimit }) => {
-        const jobId = jobs.start('refresh', (update, signal) => refresh.run(siteUrl, { gsc: doGsc, crawl, inspect, ranks, segments, full, location, startDate, endDate, maxPages, inspectLimit }, update, signal));
+        const jobId = jobs.start('refresh', async (update, signal) => {
+            const r = await refresh.run(siteUrl, { gsc: doGsc, crawl, inspect, ranks, segments, full, location, startDate, endDate, maxPages, inspectLimit }, update, signal);
+            // Property is now populated — spin up the browser dashboard and hand back its URL so the
+            // finished job (polled via check_sync_status) carries a one-click link, no extra tool call.
+            await autoServeDashboard();
+            const dashboardUrl = dashboardServerUrl();
+            return dashboardUrl ? { ...r, dashboardUrl, dashboard: `${dashboardUrl}/dashboard?siteUrl=${encodeURIComponent(siteUrl)}` } : r;
+        });
         return {
             content: [{ type: 'text', text: `Refresh started for ${siteUrl} (job ${jobId}). Poll check_sync_status.` }],
             structuredContent: { jobId, status: 'running', siteUrl },
@@ -2031,66 +2062,7 @@ export function createServer() {
                 structuredContent: { stopped },
             };
         }
-        const { url } = await startDashboardServer({
-            dataDir,
-            uiHtml: () => readFileSync(path.join(__dirname, 'src', 'ui', 'dashboard.html'), 'utf8'),
-            call: {
-                get_dashboard_data: async (a) => {
-                    const want = String(a.siteUrl ?? '');
-                    // Only serve properties that actually exist locally — getDashboardData would
-                    // otherwise CREATE an empty DB file for any bogus siteUrl posted at the API.
-                    if (!listLocalProperties(dataDir()).some(p => p.siteUrl === want))
-                        throw new Error(`unknown property ${want}`);
-                    return { ...getDashboardData(dataDir(), want), apiKeys: apiKeysStatus() };
-                },
-                related_terms: async (a) => {
-                    const r = await requireDfs(dfs).relatedTerms(String(a.keyword ?? ''), a.location, a.languageCode);
-                    return r;
-                },
-                // Content research (on-demand) — News (free Google News + paid DFS) / Videos / Trends.
-                news_discovery: async (a) => {
-                    const kw = String(a.keyword ?? '');
-                    const seen = new Set();
-                    const articles = [];
-                    const add = (x) => { const k = String(x.url || x.title || '').toLowerCase(); if (k && !seen.has(k)) {
-                        seen.add(k);
-                        articles.push(x);
-                    } };
-                    try {
-                        const g = await fetchGoogleNews(kw, { limit: 20 });
-                        for (const x of g.articles)
-                            add({ ...x, via: 'google-news' });
-                    }
-                    catch { /* free source optional */ }
-                    if (dfs) {
-                        try {
-                            const r = await dfs.serpNews(kw, a.location, a.languageCode);
-                            for (const x of r.articles)
-                                add({ ...x, via: 'dataforseo' });
-                        }
-                        catch { /* paid optional */ }
-                    }
-                    return { articles };
-                },
-                youtube_discovery: async (a) => {
-                    const r = await requireDfs(dfs).serpYoutube(String(a.keyword ?? ''), a.location, a.languageCode, a.blockDepth);
-                    return r;
-                },
-                topic_trend: async (a) => {
-                    const kws = Array.isArray(a.keywords) ? a.keywords : [String(a.keyword ?? '')].filter(Boolean);
-                    const r = await requireDfs(dfs).googleTrends(kws, a.location, a.languageCode, {});
-                    return r;
-                },
-                keyword_volume: async (a) => {
-                    const r = await requireDfs(dfs).searchVolume(a.keywords ?? [], a.location, a.languageCode);
-                    const items = (r.tasks[0]?.result ?? []).map((k) => ({
-                        keyword: k.keyword, searchVolume: k.search_volume, cpc: k.cpc, competition: k.competition,
-                    }));
-                    return { keywords: items, cached: r.cached, cost: r.cost };
-                },
-            },
-            ...(port != null ? { port } : {}),
-        });
+        const { url } = await startDashboardServer(buildWebOpts(port));
         const open = siteUrl ? `${url}/dashboard?siteUrl=${encodeURIComponent(siteUrl)}` : `${url}/`;
         const portNote = port != null && !url.endsWith(`:${port}`)
             ? ` (already running on its original port — requested port ${port} ignored; stop=true first to move it)`