Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 3 additions & 11 deletions src/resources/axons.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,9 @@ export class Axons extends APIResource {
* [Beta] Subscribe to an axon event stream via server-sent events.
*/
subscribeSse(id: string, options?: Core.RequestOptions): APIPromise<Stream<AxonEventView>> {
const defaultHeaders = {
Accept: 'text/event-stream',
};
const mergedOptions: Core.RequestOptions = {
headers: defaultHeaders,
...options,
};
return this._client.get(`/v1/axons/${id}/subscribe/sse`, {
...mergedOptions,
stream: true,
}) as APIPromise<Stream<AxonEventView>>;
return this._client.get(`/v1/axons/${id}/subscribe/sse`, { ...options, stream: true }) as APIPromise<
Stream<AxonEventView>
>;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: The SSE subscription request no longer sets Accept: text/event-stream, so it falls back to the client's default Accept: application/json. This can make the server negotiate the wrong response format (or reject the request), causing stream parsing to fail at runtime. Restore the SSE accept header when building request options. [logic error]

Severity Level: Major ⚠️
- ⚠️ Axon SSE subscription may negotiate wrong content type.
- ⚠️ `subscribeSse` consumers can see stream parsing/runtime failures.
Suggested change
return this._client.get(`/v1/axons/${id}/subscribe/sse`, { ...options, stream: true }) as APIPromise<
Stream<AxonEventView>
>;
const defaultHeaders = {
Accept: 'text/event-stream',
};
const mergedOptions: Core.RequestOptions = {
headers: defaultHeaders,
...options,
};
return this._client.get(`/v1/axons/${id}/subscribe/sse`, {
...mergedOptions,
stream: true,
}) as APIPromise<Stream<AxonEventView>>;
Steps of Reproduction ✅
1. Call `subscribeSse()` from SDK consumer code; this enters `Axons.subscribeSse` at
`src/resources/axons.ts:53`.

2. The request is built at `src/resources/axons.ts:54` with `{ ...options, stream: true }`
and no explicit `Accept` header.

3. Execute against endpoint `/v1/axons/${id}/subscribe/sse` (same method, line 54), which
is documented as SSE in the method comment at `src/resources/axons.ts:51-52`.

4. When the server requires content negotiation for SSE, absence of `Accept:
text/event-stream` can return non-SSE payload/response, causing stream handling to fail
for `Stream<AxonEventView>`.
Prompt for AI Agent 🤖
This is a comment left during a code review.

**Path:** src/resources/axons.ts
**Line:** 54:56
**Comment:**
	*Logic Error: The SSE subscription request no longer sets `Accept: text/event-stream`, so it falls back to the client's default `Accept: application/json`. This can make the server negotiate the wrong response format (or reject the request), causing stream parsing to fail at runtime. Restore the SSE accept header when building request options.

Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise.
👍 | 👎

}
}

Expand Down
14 changes: 11 additions & 3 deletions src/resources/axons/axons.ts
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,17 @@ export class Axons extends APIResource {
* [Beta] Subscribe to an axon event stream via server-sent events.
*/
subscribeSse(id: string, options?: Core.RequestOptions): APIPromise<Stream<AxonEventView>> {
return this._client.get(`/v1/axons/${id}/subscribe/sse`, { ...options, stream: true }) as APIPromise<
Stream<AxonEventView>
>;
const defaultHeaders = {
Accept: 'text/event-stream',
};
const mergedOptions: Core.RequestOptions = {
headers: defaultHeaders,
...options,
};
return this._client.get(`/v1/axons/${id}/subscribe/sse`, {
...mergedOptions,
stream: true,
}) as APIPromise<Stream<AxonEventView>>;
}
}

Expand Down
50 changes: 50 additions & 0 deletions src/sdk/axon.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,50 @@ import type {
PublishResultView,
AxonEventView,
} from '../resources/axons';
import type {
SqlBatchParams,
SqlBatchResultView,
SqlQueryParams,
SqlQueryResultView,
} from '../resources/axons/sql';

/**
* SQL operations for an axon's SQLite database.
*
* @category Axon
*/
export class AxonSqlOps {
/**
* @private
*/
constructor(
private client: Runloop,
private axonId: string,
) {}

/**
* [Beta] Execute a single parameterized SQL statement against this axon's SQLite database.
*
* @param {SqlQueryParams} params - The SQL query and optional positional parameters
* @param {Core.RequestOptions} [options] - Request options
* @returns {Promise<SqlQueryResultView>} The query result with columns, rows, and metadata
*/
async query(params: SqlQueryParams, options?: Core.RequestOptions): Promise<SqlQueryResultView> {
return this.client.axons.sql.query(this.axonId, params, options);
}

/**
* [Beta] Execute multiple SQL statements atomically within a single transaction
* against this axon's SQLite database.
*
* @param {SqlBatchParams} params - The batch of SQL statements to execute
* @param {Core.RequestOptions} [options] - Request options
* @returns {Promise<SqlBatchResultView>} One result per statement, in order
*/
async batch(params: SqlBatchParams, options?: Core.RequestOptions): Promise<SqlBatchResultView> {
return this.client.axons.sql.batch(this.axonId, params, options);
}
}

/**
* [Beta] Object-oriented interface for working with Axons.
Expand Down Expand Up @@ -42,15 +86,21 @@ import type {
* for await (const event of stream) {
* console.log(event.event_type, event.payload);
* }
*
* // Execute SQL queries
* await axon.sql.query({ sql: 'CREATE TABLE tasks (id INTEGER PRIMARY KEY, name TEXT)' });
* const result = await axon.sql.query({ sql: 'SELECT * FROM tasks WHERE id = ?', params: [1] });
* ```
*/
export class Axon {
private client: Runloop;
private _id: string;
public readonly sql: AxonSqlOps;

private constructor(client: Runloop, id: string) {
this.client = client;
this._id = id;
this.sql = new AxonSqlOps(this.client, this._id);
}

/**
Expand Down
2 changes: 1 addition & 1 deletion src/sdk/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export { Blueprint } from './blueprint';
export { Snapshot } from './snapshot';
export { StorageObject } from './storage-object';
export { Agent } from './agent';
export { Axon } from './axon';
export { Axon, AxonSqlOps } from './axon';
export { Execution } from './execution';
export { ExecutionResult } from './execution-result';
export { Scorer } from './scorer';
Expand Down
46 changes: 46 additions & 0 deletions tests/smoketests/object-oriented/axon.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,14 @@ const sdk = makeClientSDK();
});

test('subscribe to SSE stream and receive events', async () => {
// Ensure at least one event exists so the stream has something to replay
await axon.publish({
event_type: 'sse_test',
origin: 'USER_EVENT',
payload: JSON.stringify({ sse: true }),
source: 'sdk-smoke-test',
});

const stream = await axon.subscribeSse();
const events = [];
for await (const event of stream) {
Expand All @@ -91,6 +99,44 @@ const sdk = makeClientSDK();
expect(first.payload).toBeDefined();
expect(first.sequence).toBeGreaterThanOrEqual(0);
});

test('sql.query: create table and insert row', async () => {
await axon.sql.query({
sql: 'CREATE TABLE IF NOT EXISTS smoke_test (id INTEGER PRIMARY KEY, value TEXT)',
});

await axon.sql.query({
sql: 'INSERT INTO smoke_test (id, value) VALUES (?, ?)',
params: [1, 'hello'],
});

const result = await axon.sql.query({
sql: 'SELECT * FROM smoke_test WHERE id = ?',
params: [1],
});

expect(result.columns).toBeDefined();
expect(result.columns.length).toBeGreaterThan(0);
expect(result.rows.length).toBe(1);
expect(result.meta.duration_ms).toBeGreaterThanOrEqual(0);
});

test('sql.batch: execute multiple statements atomically', async () => {
const result = await axon.sql.batch({
statements: [
{ sql: 'CREATE TABLE IF NOT EXISTS batch_test (id INTEGER PRIMARY KEY, name TEXT)' },
{ sql: 'INSERT INTO batch_test (id, name) VALUES (?, ?)', params: [1, 'alice'] },
{ sql: 'INSERT INTO batch_test (id, name) VALUES (?, ?)', params: [2, 'bob'] },
{ sql: 'SELECT * FROM batch_test ORDER BY id' },
],
});

expect(result.results).toBeDefined();
expect(result.results.length).toBe(4);
const selectResult = result.results[3]!;
expect(selectResult.success).toBeDefined();
expect(selectResult.success!.rows.length).toBe(2);
});
});

describe('axon list', () => {
Expand Down
Loading