@lincoln504/pi-research 1.3.0 → 1.3.1

package/docs/CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.3.1] - 2026-08-06
+
+A dedicated post-release investigation pass over 1.3.0 — three independent
+agents (fresh-eyes code review, packaging/release-artifact audit, isolated
+runtime CLI smoke test) plus a full from-scratch local gate run — to confirm
+the shipped artifact and codebase were correct before considering the
+release closed. The packaging audit and runtime smoke test found nothing;
+the code review found one real, currently-live defect, fixed below.
+
+### Fixed
+
+- **The pi-extension research tool could report a cancelled-but-partial run as an ordinary success.** `DeepResearchOrchestrator.run()` does not throw on cancellation once at least one researcher has produced a report — it resolves normally with a fallback synthesis (the same documented contract 1.3.0's `cmdResearch` fix was built around). `research-tool-definition.ts`'s abort check only lived in its `catch` block, so this resolves-normally path fell straight through to unconditional success handling: metrics recorded `status: 'success'`, and the text handed back to the calling agent carried no indication it was a partial report. This matters more here than at the CLI: `AgentToolResult`'s `details` field is logs/UI-only by its own type contract, so `content[].text` is the *only* channel the calling agent has to learn a report is partial rather than complete — a silent miscategorization here could lead an agent to treat cut-short research as a finished answer. Same bug class as the 1.3.0 CLI fix, at a call site that round's review missed. Fixed by checking the abort signal immediately after `runResearch()` resolves: the metrics status now reflects the real outcome, and a cancellation note is prepended to the report text itself.
+
+Not a minor bump: unlike 1.3.0's `cmdResearch` fix, this does not touch the CLI's exit-code contract — it is scoped entirely to the pi-extension tool call path.
+
 ## [1.3.0] - 2026-08-06
 
 Bundles three unreleased fix rounds that accumulated on top of 1.2.0 (each

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lincoln504/pi-research",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "A set of web research tools (search, scrape, and others) and research agent system that uses them safely and efficiently.",
   "type": "module",
   "private": false,

package/skills/pi-research/SKILL.md

@@ -2,7 +2,7 @@
 name: pi-research
 description: "Multi-agent web research for any coding agent. Use for anything requiring current information from the internet — news, trends, product/service/company facts, statistics, people, places, events, APIs, library behavior, or 'what is X / how does X work' questions. Also use to search a local knowledge store of previously researched findings before doing live research. Powered by the pi-research engine (search, stealth scraping, security databases, Stack Exchange). Not for reading local files, running project commands, or analyzing this repository's own source."
 license: MIT
-metadata: { "author": "Lincoln Deen", "version": "1.3.0", "package": "@lincoln504/pi-research", "engine": "pi-research-sdk", "openclaw": { "requires": { "bins": ["node"] } } }
+metadata: { "author": "Lincoln Deen", "version": "1.3.1", "package": "@lincoln504/pi-research", "engine": "pi-research-sdk", "openclaw": { "requires": { "bins": ["node"] } } }
 allowed-tools: Bash(node:*)
 ---
 

package/src/tools/research-tool-definition.ts

@@ -259,7 +259,7 @@ export function createResearchTool(iface?: ConfigInterface): ToolDefinition {
       metrics.increment('session_runs_started_total');
 
       try {
-        const researchRunResult = await runWithRunRegistry<{ result: string; tokens: number; researchId: string }>(runRegistry, () =>
+        const researchRunResult = await runWithRunRegistry<{ result: string; tokens: number; researchId: string; cancelled: boolean }>(runRegistry, () =>
           logger.runCapturingStderr(async () => {
           const config = getConfig(ctx.cwd, iface);
           validateConfig(config);
@@ -389,6 +389,17 @@ export function createResearchTool(iface?: ConfigInterface): ToolDefinition {
                 config,
               }, internalAbort.signal);
 
+              // DeepResearchOrchestrator.run() does not throw on cancellation once at
+              // least one researcher has produced a report — it returns a fallback
+              // synthesis through its normal return path (see
+              // deep-research-orchestrator.ts's synthesisService.hasReports branch).
+              // Left unchecked, a cancel mid-run that still yields a partial report
+              // would fall straight through as if the run had completed normally,
+              // with no indication in the returned text — the only channel the
+              // calling agent sees — that it is reading a partial result. Mirrors the
+              // CLI's cancellation-latch check on its own success path (cmdResearch).
+              const wasCancelled = aborted?.aborted === true || internalAbort.signal.aborted;
+
               // Stop wave animation
               if (observerState && panelState) stopObserverWaveAnimation(observerState, panelState);
 
@@ -418,10 +429,17 @@ export function createResearchTool(iface?: ConfigInterface): ToolDefinition {
               const synthesisService = await getService<IResearchSynthesisService>(ServiceNames.RESEARCH_SYNTHESIS_SERVICE, ctx, container);
               finalResult = synthesisService.appendMetadata(finalResult, selectedModel!.id);
 
-              return { result: finalResult, tokens: runTokens, researchId };
+              // The calling agent only ever sees `content[].text` — `details` is
+              // logs/UI-only (AgentToolResult's own doc comment) — so a cancellation
+              // note has to live IN the report text itself, not just in metadata.
+              if (wasCancelled) {
+                finalResult = `*Research cancelled — the report below is a partial synthesis from what had been collected before the run was stopped.*\n\n${finalResult}`;
+              }
+
+              return { result: finalResult, tokens: runTokens, researchId, cancelled: wasCancelled };
             } catch (error) {
               if (aborted?.aborted || internalAbort.signal.aborted) {
-                return { result: 'Research cancelled.', tokens: 0, researchId };
+                return { result: 'Research cancelled.', tokens: 0, researchId, cancelled: true };
               }
               throw error;
             } finally {
@@ -431,17 +449,27 @@ export function createResearchTool(iface?: ConfigInterface): ToolDefinition {
           return researchRunResult;
         }));  // end runCapturingStderr / runWithRunRegistry
 
-        // Snapshot the run registry
+        // Snapshot the run registry. Both branches that produce researchRunResult
+        // (the success path above and its inner catch) can represent a cancelled
+        // run — status must reflect that, not assume every non-throwing outcome
+        // was an ordinary success.
         metrics.recordRunSummary({
           runId: researchId,
           startedAt: runStartedAt,
           completedAt: Date.now(),
           durationMs: Date.now() - runStartedAt,
-          status: 'success',
+          status: researchRunResult.cancelled ? 'cancelled' : 'success',
           snapshot: runRegistry.getSnapshot(),
         });
 
-        return { content: [{ type: 'text', text: researchRunResult.result }], details: { totalTokens: researchRunResult.tokens, researchId: researchRunResult.researchId } };
+        return {
+          content: [{ type: 'text', text: researchRunResult.result }],
+          details: {
+            totalTokens: researchRunResult.tokens,
+            researchId: researchRunResult.researchId,
+            ...(researchRunResult.cancelled ? { cancelled: true } : {}),
+          },
+        };
       } catch (error) {
         if (aborted?.aborted || internalAbort.signal.aborted) {
           metrics.recordRunSummary({