Skip to content

fix(sdk-swift): decode action invocations by invocation_id#335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
willwashburn wants to merge 1 commit into
base:main
Choose a base branch
from
Open

fix(sdk-swift): decode action invocations by invocation_id #335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 43 additions & 1 deletion packages/sdk-swift/Sources/Relaycast/Models.swift
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1178,14 +1178,56 @@ public struct CompleteInvocationRequest: Codable, Equatable, Sendable {
}

public struct ActionInvocation: Codable, Equatable, Sendable {
public let id: String
/// The hosted API identifies an invocation as `invocation_id` on every
/// route that returns this record (invoke ack, status poll, completion),
/// matching ``InvokeActionResult``. A plain `id` is accepted as an alias so
/// a record echoed by another surface still decodes.
public let invocationId: String

@chatgpt-codex-connectorchatgpt-codex-connectorBotAug 18, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Preserve the public id accessor

When an existing Swift consumer upgrades and accesses the documented public model as invocation.id, replacing that property with invocationId makes the consumer fail to compile even though decoding invocation_id does not require removing the old API. Keep a deprecated computed id alias forwarding to invocationId; otherwise this must be staged and documented as a major migration rather than shipped as an unrecorded fix.

AGENTS.md reference: AGENTS.md:L40-L44

Useful? React with 👍 / 👎.

public let actionName: String?
public let status: String
public let input: [String: JSONValue]?
public let output: [String: JSONValue]?
public let error: String?
public let createdAt: String?
public let updatedAt: String?
public let completedAt: String?
public let durationMs: Int?

private enum CodingKeys: String, CodingKey {
case invocationId, id, actionName, status, input, output, error, createdAt, updatedAt, completedAt, durationMs
}

public init(from decoder: Decoder) throws {
let container = try decoder.container(keyedBy: CodingKeys.self)
if let invocationId = try container.decodeIfPresent(String.self, forKey: .invocationId) {
self.invocationId = invocationId
} else {
self.invocationId = try container.decode(String.self, forKey: .id)
}
actionName = try container.decodeIfPresent(String.self, forKey: .actionName)
status = try container.decode(String.self, forKey: .status)
input = try container.decodeIfPresent([String: JSONValue].self, forKey: .input)
output = try container.decodeIfPresent([String: JSONValue].self, forKey: .output)
error = try container.decodeIfPresent(String.self, forKey: .error)
createdAt = try container.decodeIfPresent(String.self, forKey: .createdAt)
updatedAt = try container.decodeIfPresent(String.self, forKey: .updatedAt)
completedAt = try container.decodeIfPresent(String.self, forKey: .completedAt)
durationMs = try container.decodeIfPresent(Int.self, forKey: .durationMs)

@cubic-dev-aicubic-dev-aiBotAug 18, 2026

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.

P2: When the API returns a negative duration_ms, this decoder accepts it because Int permits negative values. Reject negative durations while retaining missing and null as valid optional values.

(Based on your team's feedback about nonnegative duration_ms validation.)

View Feedback

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At packages/sdk-swift/Sources/Relaycast/Models.swift, line 1215:
<comment>When the API returns a negative `duration_ms`, this decoder accepts it because `Int` permits negative values. Reject negative durations while retaining missing and `null` as valid optional values.
(Based on your team's feedback about nonnegative `duration_ms` validation.) </comment>
<file context>
@@ -1178,14 +1178,56 @@ public struct CompleteInvocationRequest: Codable, Equatable, Sendable {
+ createdAt = try container.decodeIfPresent(String.self, forKey: .createdAt)
+ updatedAt = try container.decodeIfPresent(String.self, forKey: .updatedAt)
+ completedAt = try container.decodeIfPresent(String.self, forKey: .completedAt)
+ durationMs = try container.decodeIfPresent(Int.self, forKey: .durationMs)
+ }
+
</file context>
Suggested change
durationMs=try container.decodeIfPresent(Int.self,forKey:.durationMs)
if !container.contains(.durationMs) ||try container.decodeNil(forKey:.durationMs){
durationMs =nil
}else{
letdecodedDurationMs=try container.decode(Int.self, forKey:.durationMs)
guard decodedDurationMs >=0else{
throwDecodingError.dataCorruptedError(
forKey:.durationMs,
in: container,
debugDescription:"durationMs must be nonnegative"
)
}
durationMs = decodedDurationMs
}

}

public func encode(to encoder: Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)
try container.encode(invocationId, forKey: .invocationId)
try container.encodeIfPresent(actionName, forKey: .actionName)
try container.encode(status, forKey: .status)
try container.encodeIfPresent(input, forKey: .input)
try container.encodeIfPresent(output, forKey: .output)
try container.encodeIfPresent(error, forKey: .error)
try container.encodeIfPresent(createdAt, forKey: .createdAt)
try container.encodeIfPresent(updatedAt, forKey: .updatedAt)
try container.encodeIfPresent(completedAt, forKey: .completedAt)
try container.encodeIfPresent(durationMs, forKey: .durationMs)
}
}

// MARK: - Directory, routing, A2A, certification, console
Expand Down
38 changes: 38 additions & 0 deletions packages/sdk-swift/Tests/RelaycastTests/RelaycastTests.swift
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,44 @@ final class RelaycastTests: XCTestCase {
}
}

func testActionInvocationDecodesHostedInvocationIdentifier() throws {
// The hosted API identifies an invocation as `invocation_id` on the
// status-poll and completion routes; decoding it as `id` failed every
// action completion with "Invalid Relaycast API response".
let payload = Data("""
{
"invocation_id": "inv_215317590589313024",
"action_name": "add_rectangle",
"caller_id": "215317575185170432",
"caller_name": "board-driver",
"input": {"x": 120},
"output": {"text": "Added rectangle rect-1"},
"status": "completed",
"error": null,
"duration_ms": 42,
"created_at": "2026-08-18T03:55:13.000Z",
"completed_at": "2026-08-18T03:55:14.000Z"
}
""".utf8)

let decoded = try makeRelaycastDecoder().decode(ActionInvocation.self, from: payload)
XCTAssertEqual(decoded.invocationId, "inv_215317590589313024")
XCTAssertEqual(decoded.actionName, "add_rectangle")
XCTAssertEqual(decoded.status, "completed")
XCTAssertEqual(decoded.durationMs, 42)
XCTAssertEqual(decoded.completedAt, "2026-08-18T03:55:14.000Z")
XCTAssertEqual(decoded.output?["text"], .string("Added rectangle rect-1"))
}

func testActionInvocationAcceptsPlainIdAlias() throws {
let payload = Data("""
{"id": "inv_1", "status": "completed"}
""".utf8)

let decoded = try makeRelaycastDecoder().decode(ActionInvocation.self, from: payload)
XCTAssertEqual(decoded.invocationId, "inv_1")
}

func testHttpClientEncodesSnakeCaseAndOriginHeaders() async throws {
let session = makeMockSession()
let client = try HttpClient(
Expand Down
Loading