opencandle 0.6.0 → 0.7.0

package/src/tools/sentiment/sentiment-summary.ts

@@ -1,13 +1,11 @@
 import type { AgentTool } from "@earendil-works/pi-agent-core";
+import type { ExtensionContext } from "@earendil-works/pi-coding-agent";
 import { Type } from "@sinclair/typebox";
 import { getConfig } from "../../config.js";
 import { hasCredential } from "../../onboarding/providers.js";
 import { buildSoftDegradedTag } from "../../onboarding/tool-tags.js";
 import { finnhubDateRange, getCompanyNews } from "../../providers/finnhub.js";
-import { getPostComments, getSubredditPosts } from "../../providers/reddit.js";
-import { getTwitterSentiment } from "../../providers/twitter.js";
 import { searchWeb } from "../../providers/web-search.js";
-import { wrapProvider } from "../../providers/wrap-provider.js";
 import { getQuote } from "../../providers/yahoo-finance.js";
 import { extractTickersFromQuery, FinnhubAdapter } from "../../sentiment/adapters/finnhub.js";
 import { RedditAdapter } from "../../sentiment/adapters/reddit.js";
@@ -15,6 +13,10 @@ import { TwitterAdapter } from "../../sentiment/adapters/twitter.js";
 import { WebAdapter } from "../../sentiment/adapters/web.js";
 import { getSentimentPipeline } from "../../sentiment/index.js";
 import type { SentinelRecord } from "../../sentiment/types.js";
+import type { AskUserHandler } from "../../types/index.js";
+import { formatInsightSection } from "./insight-format.js";
+import { createRedditSentimentTool } from "./reddit-sentiment.js";
+import { createTwitterSentimentTool } from "./twitter-sentiment.js";
 
 const params = Type.Object({
   query: Type.String({ description: "Ticker or topic for cross-source sentiment summary" }),
@@ -23,200 +25,271 @@ const params = Type.Object({
   ),
 });
 
-export const sentimentSummaryTool: AgentTool<typeof params> = {
-  name: "get_sentiment_summary",
-  label: "Sentiment Summary",
-  description:
-    "Cross-source sentiment summary combining Twitter, Reddit, and web/news. Returns per-source scores, aggregate sentiment, and divergence detection.",
-  parameters: params,
-  async execute(_toolCallId, args) {
-    const hours = args.hours ?? 24;
-    const config = getConfig();
-    const warnings: string[] = [];
-    const allRecords: SentinelRecord[] = [];
-
-    const twitterAdapter = new TwitterAdapter();
-    const webAdapter = new WebAdapter();
-    const finnhubAdapter = new FinnhubAdapter();
-
-    // Determine if Finnhub should be included (key configured + ticker in
-    // query). `candidateTickers` is extracted unconditionally so we can tell
-    // a "no finnhub-mappable ticker in the query" case apart from a "query
-    // has tickers but user has no Finnhub key" case — the latter warrants a
-    // soft-degraded tag so the LLM surfaces it in the Data gaps section.
-    const candidateTickers = extractTickersFromQuery(args.query);
-    const finnhubTickers = config.finnhubApiKey ? candidateTickers : [];
-    const includeFinnhub = finnhubTickers.length > 0 && Boolean(config.finnhubApiKey);
-    const finnhubSoftDegraded = candidateTickers.length > 0 && !hasCredential("finnhub");
-
-    // Finnhub fetch (built separately to avoid mixing promise types in allSettled)
-    const finnhubFetch: Promise<import("../../providers/finnhub.js").FinnhubArticle[]> =
-      includeFinnhub
-        ? (async () => {
-            const { from, to } = finnhubDateRange("day");
-            const arrays = await Promise.all(
-              finnhubTickers.map((sym) => getCompanyNews(sym, from, to, config.finnhubApiKey!)),
-            );
-            return arrays.flat();
-          })()
-        : Promise.resolve([]);
-
-    // Fetch all sources in parallel
-    const [twitterResult, redditResults, webResult, finnhubResult] = await Promise.allSettled([
-      // Twitter
-      wrapProvider("twitter", () => getTwitterSentiment(args.query, 50, hours)),
-      // Reddit — cross-subreddit
-      fetchRedditCrossSubreddit(
-        args.query,
-        config.sentiment?.defaultSubreddits ?? ["wallstreetbets", "stocks", "investing", "options"],
-      ),
-      // Web
-      searchWeb(args.query, { freshness: "day", limit: 10, category: "news" }),
-      // Finnhub — only when includeFinnhub; otherwise resolves to []
-      finnhubFetch,
-    ]);
-
-    // Process Twitter
-    if (twitterResult.status === "fulfilled" && twitterResult.value.status === "ok") {
-      const records = twitterAdapter.mapToRecords(twitterResult.value.data, args.query);
-      allRecords.push(...records);
-    } else {
-      const reason =
-        twitterResult.status === "rejected"
-          ? (twitterResult.reason?.message ?? "unknown error")
-          : ((twitterResult.value as any).reason ?? "unavailable");
-      warnings.push(`Twitter: ${reason}`);
-    }
-
-    // Process Reddit
-    if (redditResults.status === "fulfilled") {
-      const { records: redditRecords, warnings: redditWarnings } = redditResults.value;
-      allRecords.push(...redditRecords);
-      warnings.push(...redditWarnings);
-    } else {
-      warnings.push(`Reddit: ${redditResults.reason?.message ?? "unknown error"}`);
-    }
-
-    // Process Web
-    if (webResult.status === "fulfilled" && webResult.value.status === "ok") {
-      const records = webAdapter.mapToRecords(webResult.value.data, args.query);
-      allRecords.push(...records);
-    } else {
-      const reason =
-        webResult.status === "rejected"
-          ? (webResult.reason?.message ?? "unknown error")
-          : ((webResult.value as any).reason ?? "unavailable");
-      warnings.push(`Web: ${reason}`);
-    }
-
-    // Process Finnhub (only when included — otherwise resolves to empty array anyway)
-    if (includeFinnhub) {
-      if (finnhubResult.status === "fulfilled") {
-        const articles = finnhubResult.value;
-        if (articles.length > 0) {
-          const records = finnhubAdapter.mapToRecords(articles, args.query);
-          allRecords.push(...records);
+type ToolTextContent = { type: string; text?: string };
+type SetupAwareExecute<TParams, TDetails> = (
+  toolCallId: string,
+  params: TParams,
+  signal?: AbortSignal,
+  onUpdate?: undefined,
+  ctx?: ExtensionContext,
+) => Promise<{ content: ToolTextContent[]; details: TDetails }>;
+
+interface SentimentSummaryToolOptions {
+  askUserHandler?: AskUserHandler;
+}
+
+export function createSentimentSummaryTool(
+  options: SentimentSummaryToolOptions = {},
+): AgentTool<typeof params> {
+  return {
+    name: "get_sentiment_summary",
+    label: "Sentiment Summary",
+    description:
+      "Cross-source sentiment summary combining Twitter, Reddit, and web/news. Returns per-source scores, aggregate sentiment, and divergence detection.",
+    parameters: params,
+    async execute(_toolCallId, args, _signal, _onUpdate, ctx?: ExtensionContext) {
+      const hours = args.hours ?? 24;
+      const config = getConfig();
+      const warnings: string[] = [];
+      const allRecords: SentinelRecord[] = [];
+
+      const twitterAdapter = new TwitterAdapter();
+      const webAdapter = new WebAdapter();
+      const finnhubAdapter = new FinnhubAdapter();
+
+      // Determine if Finnhub should be included (key configured + ticker in
+      // query). `candidateTickers` is extracted unconditionally so we can tell
+      // a "no finnhub-mappable ticker in the query" case apart from a "query
+      // has tickers but user has no Finnhub key" case — the latter warrants a
+      // soft-degraded tag so the LLM surfaces it in the Data gaps section.
+      const candidateTickers = extractTickersFromQuery(args.query);
+      const finnhubTickers = config.finnhubApiKey ? candidateTickers : [];
+      const includeFinnhub = finnhubTickers.length > 0 && Boolean(config.finnhubApiKey);
+      const finnhubSoftDegraded = candidateTickers.length > 0 && !hasCredential("finnhub");
+
+      const fetchFinnhub = async (): Promise<
+        import("../../providers/finnhub.js").FinnhubArticle[]
+      > => {
+        if (!includeFinnhub) return [];
+        const { from, to } = finnhubDateRange("day");
+        const arrays = await Promise.all(
+          finnhubTickers.map((sym) => getCompanyNews(sym, from, to, config.finnhubApiKey!)),
+        );
+        return arrays.flat();
+      };
+
+      // External-tool sources may need ask_user setup. Run them through the
+      // source-specific tools so install/login/skip preferences behave the same
+      // in cross-source summaries as they do in direct source requests.
+      try {
+        const twitterTool = createTwitterSentimentTool({
+          askUserHandler: options.askUserHandler,
+        });
+        const executeTwitter = twitterTool.execute as unknown as SetupAwareExecute<
+          { query: string; limit: number; hours: number },
+          NonNullable<Awaited<ReturnType<typeof twitterTool.execute>>["details"]> | null
+        >;
+        const twitterResult = await executeTwitter(
+          "summary-twitter",
+          { query: args.query, limit: 50, hours },
+          undefined,
+          undefined,
+          ctx,
+        );
+        if (twitterResult.details) {
+          allRecords.push(...twitterAdapter.mapToRecords(twitterResult.details, args.query));
+        } else {
+          warnings.push(sourceToolWarning("Twitter", toolText(twitterResult.content)));
         }
-      } else {
-        warnings.push(`Finnhub: ${finnhubResult.reason?.message ?? "unknown error"}`);
+      } catch (err) {
+        warnings.push(`Twitter: ${err instanceof Error ? err.message : String(err)}`);
       }
-    }
-
-    const softDegradedPrefix = finnhubSoftDegraded
-      ? `${buildSoftDegradedTag({
-          provider: "finnhub",
-          fallback: "other-sentiment-sources",
-          remediation: "run /connect news to enable Finnhub company news",
-        })}\n\n`
-      : "";
 
-    if (allRecords.length === 0) {
-      return {
-        content: [
+      try {
+        const redditTool = createRedditSentimentTool({
+          askUserHandler: options.askUserHandler,
+        });
+        const executeReddit = redditTool.execute as unknown as SetupAwareExecute<
+          { query: string; subreddits: string[] },
+          NonNullable<Awaited<ReturnType<typeof redditTool.execute>>["details"]> | null
+        >;
+        const redditResult = await executeReddit(
+          "summary-reddit",
           {
-            type: "text",
-            text: `${softDegradedPrefix}⚠ Sentiment summary unavailable for "${args.query}" — no sources returned data.\n${warnings.join("\n")}`,
+            query: args.query,
+            subreddits: config.sentiment?.defaultSubreddits ?? [
+              "wallstreetbets",
+              "stocks",
+              "investing",
+              "options",
+            ],
           },
-        ],
-        details: null as any,
-      };
-    }
-
-    // Score and index through pipeline
-    const pipeline = getSentimentPipeline();
-    const result = await pipeline.processRecords(allRecords, args.query);
-
-    // Group by source (exclude comments from per-source averages)
-    const bySource: Record<string, { total: number; count: number }> = {};
-    for (const rec of result.fresh) {
-      if (rec.metadata.isComment) continue;
-      if (!bySource[rec.source]) bySource[rec.source] = { total: 0, count: 0 };
-      bySource[rec.source].total += rec.sentiment.score;
-      bySource[rec.source].count++;
-    }
-
-    const lines: string[] = [];
-    lines.push(`**Sentiment summary for "${args.query}"** (last ${hours}h):`);
-    lines.push("");
-    lines.push("| Source | Score | Count | Signal |");
-    lines.push("|--------|-------|-------|--------|");
-
-    let totalScore = 0;
-    let totalCount = 0;
-    for (const [source, stats] of Object.entries(bySource)) {
-      const avg = stats.count > 0 ? stats.total / stats.count : 0;
-      const label = sentimentLabel(avg);
-      const sourceName =
-        source === "web" ? "Web/News" : source.charAt(0).toUpperCase() + source.slice(1);
-      lines.push(
-        `| ${sourceName} | ${avg >= 0 ? "+" : ""}${avg.toFixed(2)} | ${stats.count} | ${label} |`,
-      );
-      totalScore += stats.total;
-      totalCount += stats.count;
-    }
-
-    const aggregate = totalCount > 0 ? totalScore / totalCount : 0;
-    lines.push("");
-    lines.push(
-      `**Aggregate:** ${aggregate >= 0 ? "+" : ""}${aggregate.toFixed(2)} (${sentimentLabel(aggregate)})`,
-    );
-
-    const priceContext = await buildPriceContext(candidateTickers[0], aggregate);
-    if (priceContext) {
-      lines.push("");
-      lines.push(priceContext);
-    }
+          undefined,
+          undefined,
+          ctx,
+        );
+        if (redditResult.details) {
+          allRecords.push(
+            ...(redditResult.details.records ??
+              new RedditAdapter().mapPostsToRecords(redditResult.details, args.query)),
+          );
+        } else {
+          warnings.push(sourceToolWarning("Reddit", toolText(redditResult.content)));
+        }
+      } catch (err) {
+        warnings.push(`Reddit: ${err instanceof Error ? err.message : String(err)}`);
+      }
 
-    lines.push("");
-    lines.push(
-      "Source-coverage risk: sentiment can be noisy and missing sources can skew the signal; treat this as supporting evidence, not a standalone buy/sell input.",
-    );
+      const [webResult, finnhubResult] = await Promise.allSettled([
+        searchWeb(args.query, { freshness: "day", limit: 10, category: "news" }),
+        // Finnhub — only when includeFinnhub; otherwise resolves to []
+        fetchFinnhub(),
+      ]);
 
-    // Divergence
-    if (result.divergence && result.divergence.detected) {
-      lines.push("");
-      lines.push(result.divergence.message);
-    } else if (result.divergence && !result.divergence.detected) {
+      // Process Web
+      if (webResult.status === "fulfilled" && webResult.value.status === "ok") {
+        const records = webAdapter.mapToRecords(webResult.value.data, args.query);
+        allRecords.push(...records);
+      } else {
+        const reason =
+          webResult.status === "rejected"
+            ? (webResult.reason?.message ?? "unknown error")
+            : ((webResult.value as any).reason ?? "unavailable");
+        warnings.push(`Web: ${reason}`);
+      }
+
+      // Process Finnhub (only when included — otherwise resolves to empty array anyway)
+      if (includeFinnhub) {
+        if (finnhubResult.status === "fulfilled") {
+          const articles = finnhubResult.value;
+          if (articles.length > 0) {
+            const records = finnhubAdapter.mapToRecords(articles, args.query);
+            allRecords.push(...records);
+          }
+        } else {
+          warnings.push(`Finnhub: ${finnhubResult.reason?.message ?? "unknown error"}`);
+        }
+      }
+
+      const softDegradedPrefix = finnhubSoftDegraded
+        ? `${buildSoftDegradedTag({
+            provider: "finnhub",
+            fallback: "other-sentiment-sources",
+            remediation: "run /connect news to enable Finnhub company news",
+          })}\n\n`
+        : "";
+
+      if (allRecords.length === 0) {
+        return {
+          content: [
+            {
+              type: "text",
+              text: `${softDegradedPrefix}⚠ Sentiment summary unavailable for "${args.query}" — no sources returned data.\n${warnings.join("\n")}`,
+            },
+          ],
+          details: null as any,
+        };
+      }
+
+      const summaryWarnings = warnings.map(stripOpenCandleControlLines);
+
+      // Score and index through pipeline
+      const pipeline = getSentimentPipeline();
+      const result = await pipeline.processRecords(allRecords, args.query);
+      const insight =
+        result.insight && summaryWarnings.length > 0
+          ? {
+              ...result.insight,
+              caveats: [
+                ...result.insight.caveats,
+                ...summaryWarnings.map((warning) => `Source warning: ${warning}`),
+              ],
+            }
+          : result.insight;
+
+      // Group by source (exclude comments from per-source averages)
+      const bySource: Record<string, { total: number; count: number }> = {};
+      for (const rec of result.fresh) {
+        if (rec.metadata.isComment) continue;
+        if (!bySource[rec.source]) bySource[rec.source] = { total: 0, count: 0 };
+        bySource[rec.source].total += rec.sentiment.score;
+        bySource[rec.source].count++;
+      }
+
+      const lines: string[] = [];
+      lines.push(`**Sentiment summary for "${args.query}"** (last ${hours}h):`);
       lines.push("");
-      lines.push(result.divergence.message);
-    }
+      lines.push("| Source | Score | Count | Signal |");
+      lines.push("|--------|-------|-------|--------|");
+
+      let totalScore = 0;
+      let totalCount = 0;
+      for (const [source, stats] of Object.entries(bySource)) {
+        const avg = stats.count > 0 ? stats.total / stats.count : 0;
+        const label = sentimentLabel(avg);
+        const sourceName =
+          source === "web" ? "Web/News" : source.charAt(0).toUpperCase() + source.slice(1);
+        lines.push(
+          `| ${sourceName} | ${avg >= 0 ? "+" : ""}${avg.toFixed(2)} | ${stats.count} | ${label} |`,
+        );
+        totalScore += stats.total;
+        totalCount += stats.count;
+      }
 
-    // Trend
-    if (result.trend && result.trend.length > 0) {
-      const t = result.trend[0];
+      const aggregate = totalCount > 0 ? totalScore / totalCount : 0;
       lines.push("");
-      lines.push(`Trend: ${t.sparkline} ${t.direction} (${t.count} records)`);
-    }
+      lines.push(
+        `**Aggregate:** ${aggregate >= 0 ? "+" : ""}${aggregate.toFixed(2)} (${sentimentLabel(aggregate)})`,
+      );
+
+      if (insight) {
+        lines.push(...formatInsightSection(insight));
+      }
+
+      const priceContext = await buildPriceContext(candidateTickers[0], aggregate);
+      if (priceContext) {
+        lines.push("");
+        lines.push(priceContext);
+      } else if (candidateTickers[0]) {
+        lines.push("");
+        lines.push(
+          `Price context: unavailable for ${candidateTickers[0]}; sentiment/price divergence could not be evaluated.`,
+        );
+      }
 
-    if (warnings.length > 0) {
       lines.push("");
-      lines.push(warnings.map((w) => `⚠ ${w}`).join("\n"));
-    }
+      lines.push(
+        "Source-coverage risk: sentiment can be noisy and missing sources can skew the signal; treat this as supporting evidence, not a standalone buy/sell input.",
+      );
+
+      // Divergence
+      if (result.divergence && result.divergence.detected) {
+        lines.push("");
+        lines.push(result.divergence.message);
+      } else if (result.divergence && !result.divergence.detected) {
+        lines.push("");
+        lines.push(result.divergence.message);
+      }
+
+      // Trend
+      if (result.trend && result.trend.length > 0) {
+        const t = result.trend[0];
+        lines.push("");
+        lines.push(`Trend: ${t.sparkline} ${t.direction} (${t.count} records)`);
+      }
+
+      if (summaryWarnings.length > 0) {
+        lines.push("");
+        lines.push(summaryWarnings.map((w) => `⚠ ${w}`).join("\n"));
+      }
+
+      const output = softDegradedPrefix + lines.join("\n");
+      return { content: [{ type: "text", text: output }], details: { ...result, insight } };
+    },
+  };
+}
 
-    const output = softDegradedPrefix + lines.join("\n");
-    return { content: [{ type: "text", text: output }], details: result };
-  },
-};
+export const sentimentSummaryTool = createSentimentSummaryTool();
 
 async function buildPriceContext(
   symbol: string | undefined,
@@ -275,59 +348,6 @@ function formatQuoteFreshnessNote(timestamp: number | undefined): string {
   return ` Last available quote timestamp: ${quoteStamp} ET.${marketClosedNote}`;
 }
 
-async function fetchRedditCrossSubreddit(
-  query: string,
-  subreddits: string[],
-): Promise<{ records: SentinelRecord[]; warnings: string[] }> {
-  const adapter = new RedditAdapter();
-  const records: SentinelRecord[] = [];
-  const warnings: string[] = [];
-  const config = getConfig();
-  const commentsPerPost = config.sentiment?.commentsPerPost ?? 5;
-
-  for (const sub of subreddits) {
-    const result = await wrapProvider("reddit", () => getSubredditPosts(sub, 25));
-    if (result.status === "unavailable") {
-      warnings.push(`Reddit r/${sub}: ${result.reason}`);
-      continue;
-    }
-    const postRecords = adapter.mapPostsToRecords(result.data, query);
-
-    // Topic filter
-    const queryLower = query.toLowerCase();
-    const filtered = postRecords.filter(
-      (r) =>
-        r.text.toLowerCase().includes(queryLower) ||
-        (r.title?.toLowerCase().includes(queryLower) ?? false),
-    );
-    records.push(...filtered);
-
-    // Fetch comments for top posts
-    const topPosts = [...filtered]
-      .sort((a, b) => b.engagement.score - a.engagement.score)
-      .slice(0, 3); // fewer per sub since we're searching multiple
-    for (const post of topPosts) {
-      if ((post.engagement.replies ?? 0) === 0) continue;
-      try {
-        const comments = await getPostComments(sub, post.sourceId, commentsPerPost);
-        records.push(...adapter.mapCommentsToRecords(comments, post.sourceId, sub, query));
-      } catch {
-        /* non-fatal */
-      }
-    }
-  }
-
-  // Deduplicate
-  const seen = new Set<string>();
-  const deduped = records.filter((r) => {
-    if (seen.has(r.sourceId)) return false;
-    seen.add(r.sourceId);
-    return true;
-  });
-
-  return { records: deduped, warnings };
-}
-
 function sentimentLabel(score: number): string {
   if (score > 0.3) return "Bullish";
   if (score < -0.3) return "Bearish";
@@ -335,3 +355,29 @@ function sentimentLabel(score: number): string {
   if (score < 0) return "Leaning Bearish";
   return "Neutral";
 }
+
+function toolText(content: ToolTextContent[]): string {
+  return content
+    .map((part) => (part.type === "text" ? (part.text ?? "") : ""))
+    .filter(Boolean)
+    .join("\n");
+}
+
+function sourceToolWarning(source: string, text: string): string {
+  const lines = text
+    .split("\n")
+    .map((line) => line.trim())
+    .filter(Boolean);
+  const tag = lines.find((line) => line.includes("[OPENCANDLE_"));
+  const summary = lines.find((line) => !line.includes("[OPENCANDLE_")) ?? "unavailable";
+  return tag ? `${source}: ${summary}\n${tag}` : `${source}: ${summary}`;
+}
+
+function stripOpenCandleControlLines(text: string): string {
+  const stripped = text
+    .split("\n")
+    .map((line) => line.trim())
+    .filter((line) => line.length > 0 && !line.startsWith("[OPENCANDLE_"))
+    .join("\n");
+  return stripped || "unavailable";
+}