peptide-repo/prautoblogger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(B1): persist request_json on every chat LLM call via process-scoped recorder

Browse Source 
The OpenRouter provider stashes the outgoing request BODY (never headers --
Authorization is built separately and build_body() copies only whitelisted
option keys) in the new PRAutoBlogger_Request_Recorder before dispatch;
Cost_Tracker::log_api_call() consumes it (consume-once) into
generation_log.request_json. All seven chat call sites covered with zero
call-site changes; error/timeout rows carry the request too. Retention
rides the existing prautoblogger_request_json_retention_days prune.

Unblocks M3 edit+rerun (stage inputs now exist) and makes the M2 dossier
raw-input trace real (QA seq 20 F1).

Agent-Session: engineer-prab-m3-20260612
This commit is contained in:
peptiderepo
2026-06-12 12:59:49 +00:00
parent 3b6a302f95
commit 1b31ef6396
5 changed files with 385 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
includes/core/class-cost-tracker.php
View File

@@ -69,7 +69,9 @@ class PRAutoBlogger_Cost_Tracker {
/**
* Log an API call with its token usage and estimated cost.
*
* Side effects: database insert into prab_generation_log.
* Side effects: database insert into prab_generation_log. Consumes the
* Request_Recorder stash (v0.20.0 / B1) into the row's request_json so
* every chat call's input is persisted (retention-pruned after R days).
*
* @param int|null $post_id WordPress post ID (null during generation, set later).
* @param string $stage Pipeline stage (see PRAutoBlogger_Stage_Display_Map).
@@ -117,6 +119,7 @@ class PRAutoBlogger_Cost_Tracker {
'estimated_cost' => $cost,
'response_status' => $response_status,
'error_message' => $error_message,
'request_json' => PRAutoBlogger_Request_Recorder::consume(),
'agent_role' => $agent_role ?? PRAutoBlogger_Stage_Display_Map::default_agent_role( $stage ),
'prompt_version' => $this->resolve_prompt_version( $stage, $prompt_key ),
'created_at' => current_time( 'mysql' ),

73
includes/core/class-request-recorder.php Normal file
View File

@@ -0,0 +1,73 @@
<?php
declare(strict_types=1);
/**
* phpcs:ignore WordPress.Files.FileName.InvalidClassFileName -- class naming convention differs from WordPress standard
*
* Per-PHP-process stash for the most recent outgoing LLM request body.
*
* What: A process-scoped static slot recording the JSON request body the
* OpenRouter provider is about to dispatch, so Cost_Tracker::
* log_api_call() can persist it to `generation_log.request_json`
* (v0.20.0 / B1) without threading the body through every call
* site. Mirrors the Run_Context precedent (v0.18.0).
*
* SECURITY GUARANTEE: only the request BODY is ever recorded.
* Authorization headers are built separately
* (Request_Builder::build_headers()) and can never reach this
* class; build_body() copies only whitelisted option keys.
*
* Consume-once semantics: consume() clears the slot, and record()
* overwrites it at every dispatch — so a stale body from an
* unlogged failed call can never attach to a later, unrelated
* log row.
* Who triggers it: OpenRouter_Provider::send_chat_completion() (record,
* pre-dispatch so error rows carry the request too);
* Cost_Tracker::log_api_call() (consume).
* Dependencies: none.
*
* @see providers/class-open-router-provider.php — Records before dispatch.
* @see core/class-cost-tracker.php — Consumes into the log row.
* @see core/class-run-context.php — The pattern this mirrors.
* @see ARCHITECTURE.md #24 — Edit + re-run substrate (B1).
*/
class PRAutoBlogger_Request_Recorder {
/** @var string|null JSON-encoded request body of the in-flight LLM call. */
private static ?string $request_json = null;
/**
* Record the outgoing request body for the next log row.
*
* Overwrites any previous stash (one in-flight chat call per PHP
* process). Bodies that fail JSON encoding are skipped silently —
* the log row's request_json stays NULL, never blocking the call.
*
* @param array<string, mixed> $body Request body from Request_Builder::build_body().
* @return void
*/
public static function record( array $body ): void {
$encoded = wp_json_encode( $body );
self::$request_json = is_string( $encoded ) ? $encoded : null;
}
/**
* Return the stashed request body and clear the slot (consume-once).
*
* @return string|null JSON request body, or null when nothing is stashed.
*/
public static function consume(): ?string {
$json = self::$request_json;
self::$request_json = null;
return $json;
}
/**
* Clear the stash (tests / defensive teardown).
*
* @return void
*/
public static function clear(): void {
self::$request_json = null;
}
}

7
includes/providers/class-open-router-provider.php
View File

@@ -78,6 +78,13 @@ class PRAutoBlogger_OpenRouter_Provider implements PRAutoBlogger_LLM_Provider_In
// reasoning token cap + completion headroom — lives in the builder.
$body = $builder->build_body( $messages, $model, $options );
// v0.20.0 (B1): stash the outgoing request body so the next
// log_api_call() persists it to generation_log.request_json.
// Only the BODY is recorded -- Authorization lives exclusively in
// build_headers()' return and can never reach the recorder.
// Recorded BEFORE dispatch so error/timeout rows carry it too.
PRAutoBlogger_Request_Recorder::record( $body );
// Whether the outgoing request has reasoning enabled — drives the
// empty-completion retry decision after parse.
$reasoning_active = isset( $body['reasoning'] ) && false !== ( $body['reasoning']['enabled'] ?? true );

181
tests/unit/Core/CostTrackerRequestJsonTest.php Normal file
View File

@@ -0,0 +1,181 @@
<?php
/**
* Tests for the v0.20.0 (B1) request_json persistence in
* PRAutoBlogger_Cost_Tracker::log_api_call().
*
* Every chat call's request body must land on its generation_log row
* (stage inputs exist for edit + re-run; the dossier raw-input trace is
* no longer hollow — QA M2 F1), with consume-once isolation between rows.
*
* @package PRAutoBlogger\Tests\Core
*/
namespace PRAutoBlogger\Tests\Core;
use PRAutoBlogger\Tests\BaseTestCase;
class CostTrackerRequestJsonTest extends BaseTestCase {
/**
* @var \PHPUnit\Framework\MockObject\MockObject Mock $wpdb instance.
*/
private $wpdb;
/**
* Rows captured from $wpdb->insert().
*
* @var array<int, array<string, mixed>>
*/
private array $inserted = array();
protected function setUp(): void {
parent::setUp();
$this->inserted = array();
$this->wpdb = $this->create_mock_wpdb();
$GLOBALS['wpdb'] = $this->wpdb;
$this->wpdb->insert_id = 7;
$this->wpdb->method( 'insert' )->willReturnCallback(
function ( $table, $row ) {
// Capture generation_log rows only — the Logger also
// inserts (event_log) when e.g. Pricing warns on an
// unknown model; those rows are not under test.
if ( false !== strpos( (string) $table, 'generation_log' ) ) {
$this->inserted[] = (array) $row;
}
return 1;
}
);
$this->stub_get_option( array() );
\PRAutoBlogger_Request_Recorder::clear();
}
protected function tearDown(): void {
\PRAutoBlogger_Request_Recorder::clear();
unset( $GLOBALS['wpdb'] );
parent::tearDown();
}
/**
* log_api_call() persists the recorder stash into request_json.
*/
public function test_log_api_call_persists_recorded_request_json(): void {
\PRAutoBlogger_Request_Recorder::record(
array(
'model' => 'google/gemini-2.5-flash-lite',
'messages' => array( array( 'role' => 'user', 'content' => 'draft prompt' ) ),
)
);
( new \PRAutoBlogger_Cost_Tracker() )->log_api_call(
null,
'draft',
'OpenRouter',
'google/gemini-2.5-flash-lite',
100,
500
);
$this->assertCount( 1, $this->inserted );
$row = $this->inserted[0];
$this->assertArrayHasKey( 'request_json', $row );
$decoded = json_decode( (string) $row['request_json'], true );
$this->assertSame( 'draft prompt', $decoded['messages'][0]['content'] );
}
/**
* Consume-once isolation: a second log row written with no new send
* in between must get NULL, never the previous call's body.
*/
public function test_second_log_row_without_new_record_gets_null(): void {
\PRAutoBlogger_Request_Recorder::record( array( 'model' => 'm1' ) );
$tracker = new \PRAutoBlogger_Cost_Tracker();
$tracker->log_api_call( null, 'draft', 'OpenRouter', 'm1', 10, 10 );
$tracker->log_api_call( null, 'polish', 'OpenRouter', 'm1', 10, 10 );
$this->assertCount( 2, $this->inserted );
$this->assertNotNull( $this->inserted[0]['request_json'] );
$this->assertNull( $this->inserted[1]['request_json'] );
}
/**
* Historical behavior preserved: nothing recorded -> request_json NULL.
*/
public function test_log_api_call_without_stash_writes_null(): void {
( new \PRAutoBlogger_Cost_Tracker() )->log_api_call(
null,
'analysis',
'OpenRouter',
'google/gemini-2.5-flash-lite',
10,
10
);
$this->assertCount( 1, $this->inserted );
$this->assertNull( $this->inserted[0]['request_json'] );
}
/**
* The persisted payload can never contain credential material — the
* provider records only build_body() output (headers are separate).
* Belt-and-braces audit on the exact column value.
*/
public function test_persisted_request_json_contains_no_auth_header(): void {
$this->stub_get_option( array() );
$builder = new \PRAutoBlogger_OpenRouter_Request_Builder();
\PRAutoBlogger_Request_Recorder::record(
$builder->build_body(
array( array( 'role' => 'user', 'content' => 'x' ) ),
'google/gemini-2.5-flash-lite',
array( 'max_tokens' => 100 )
)
);
( new \PRAutoBlogger_Cost_Tracker() )->log_api_call(
null,
'draft',
'OpenRouter',
'google/gemini-2.5-flash-lite',
10,
10
);
$json = (string) $this->inserted[0]['request_json'];
$this->assertStringNotContainsString( 'Authorization', $json );
$this->assertStringNotContainsString( 'Bearer', $json );
$this->assertStringNotContainsString( 'sk-or-', $json );
}
/**
* The half-migrated-schema legacy retry (v0.18.0 pattern) keeps
* request_json — the column predates the audit columns (v1.1.0
* schema) and exists on every site.
*/
public function test_legacy_schema_retry_keeps_request_json(): void {
$this->inserted = array();
$wpdb = $this->create_mock_wpdb();
$wpdb->insert_id = 7;
$calls = 0;
$wpdb->method( 'insert' )->willReturnCallback(
function ( $table, $row ) use ( &$calls ) {
if ( false === strpos( (string) $table, 'generation_log' ) ) {
return 1; // Logger/event_log noise — not under test.
}
++$calls;
$this->inserted[] = (array) $row;
return 1 === $calls ? false : 1; // First insert fails (missing v0.18.0 columns).
}
);
$GLOBALS['wpdb'] = $wpdb;
\PRAutoBlogger_Request_Recorder::record( array( 'model' => 'm1' ) );
( new \PRAutoBlogger_Cost_Tracker() )->log_api_call( null, 'draft', 'OpenRouter', 'm1', 10, 10 );
$this->assertCount( 2, $this->inserted );
$retry_row = $this->inserted[1];
$this->assertArrayNotHasKey( 'agent_role', $retry_row );
$this->assertArrayNotHasKey( 'prompt_version', $retry_row );
$this->assertArrayHasKey( 'request_json', $retry_row );
$this->assertNotNull( $retry_row['request_json'] );
}
}

120
tests/unit/Core/RequestRecorderTest.php Normal file
View File

@@ -0,0 +1,120 @@
<?php
/**
* Tests for PRAutoBlogger_Request_Recorder (v0.20.0 / B1).
*
* Locks the consume-once + overwrite-on-record semantics that make it
* impossible for a stale request body to attach to an unrelated log row,
* and the no-Authorization guarantee of the record path.
*
* @package PRAutoBlogger\Tests\Core
*/
namespace PRAutoBlogger\Tests\Core;
use PRAutoBlogger\Tests\BaseTestCase;
class RequestRecorderTest extends BaseTestCase {
protected function setUp(): void {
parent::setUp();
\PRAutoBlogger_Request_Recorder::clear();
}
protected function tearDown(): void {
\PRAutoBlogger_Request_Recorder::clear();
parent::tearDown();
}
/**
* consume() returns the recorded body exactly once, then null.
*/
public function test_consume_returns_recorded_body_exactly_once(): void {
\PRAutoBlogger_Request_Recorder::record(
array(
'model' => 'google/gemini-2.5-flash-lite',
'messages' => array( array( 'role' => 'user', 'content' => 'hi' ) ),
)
);
$first = \PRAutoBlogger_Request_Recorder::consume();
$this->assertIsString( $first );
$decoded = json_decode( $first, true );
$this->assertSame( 'google/gemini-2.5-flash-lite', $decoded['model'] );
$this->assertSame( 'hi', $decoded['messages'][0]['content'] );
// Consume-once: the slot is cleared by the first read.
$this->assertNull( \PRAutoBlogger_Request_Recorder::consume() );
}
/**
* record() overwrites the previous stash — a stale body from an
* unlogged earlier call can never survive into the next dispatch.
*/
public function test_record_overwrites_previous_stash(): void {
\PRAutoBlogger_Request_Recorder::record( array( 'model' => 'first/model' ) );
\PRAutoBlogger_Request_Recorder::record( array( 'model' => 'second/model' ) );
$decoded = json_decode( (string) \PRAutoBlogger_Request_Recorder::consume(), true );
$this->assertSame( 'second/model', $decoded['model'] );
}
/**
* consume() with nothing recorded returns null (historical rows /
* non-chat log writes keep request_json NULL).
*/
public function test_consume_without_record_returns_null(): void {
$this->assertNull( \PRAutoBlogger_Request_Recorder::consume() );
}
/**
* clear() empties the slot.
*/
public function test_clear_empties_slot(): void {
\PRAutoBlogger_Request_Recorder::record( array( 'model' => 'm' ) );
\PRAutoBlogger_Request_Recorder::clear();
$this->assertNull( \PRAutoBlogger_Request_Recorder::consume() );
}
/**
* The full record path for a body built by the real Request_Builder
* from poisoned options can never contain credential material:
* build_body() copies only whitelisted keys and headers are built
* separately, so the recorder's JSON has no Authorization shape.
*/
public function test_recorded_builder_body_never_contains_auth_material(): void {
$this->stub_get_option( array() );
$builder = new \PRAutoBlogger_OpenRouter_Request_Builder();
$body = $builder->build_body(
array( array( 'role' => 'user', 'content' => 'write about BPC-157' ) ),
'google/gemini-2.5-flash-lite',
array(
'temperature' => 0.7,
'max_tokens' => 4000,
// Hostile/accidental injection attempts — must all be dropped.
'Authorization' => 'Bearer sk-or-secret-key-123',
'headers' => array( 'Authorization' => 'Bearer sk-or-secret-key-123' ),
'api_key' => 'sk-or-secret-key-123',
// Caller metadata — never sent upstream, never recorded.
'stage' => 'draft',
'prompt_key' => 'content.draft',
'empty_retry' => true,
)
);
\PRAutoBlogger_Request_Recorder::record( $body );
$json = (string) \PRAutoBlogger_Request_Recorder::consume();
$this->assertStringNotContainsString( 'Authorization', $json );
$this->assertStringNotContainsString( 'Bearer', $json );
$this->assertStringNotContainsString( 'sk-or-', $json );
$this->assertStringNotContainsString( 'api_key', $json );
$this->assertStringNotContainsString( 'empty_retry', $json );
$this->assertStringNotContainsString( 'prompt_key', $json );
$decoded = json_decode( $json, true );
$this->assertSame(
array( 'model', 'messages', 'temperature', 'max_tokens' ),
array_keys( $decoded )
);
}
}