Conversation
Contributor
|
CodeAnt AI is reviewing your PR. Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
codeant-ai
bot
added
the
size:XL
Contributor
Sequence DiagramThis PR adds a new axon interface to the SDK that wraps low level axon API calls in an object oriented Axon class. The main flow is creating an axon through sdk.axon and then using the returned Axon object to publish events or subscribe to its event stream. sequenceDiagram
participant Developer
participant RunloopSDK
participant AxonOps
participant Axon
participant RunloopAPI
Developer->>RunloopSDK: Initialize SDK client
RunloopSDK->>AxonOps: Expose axon operations
Developer->>AxonOps: Create axon
AxonOps->>RunloopAPI: Create axon request
RunloopAPI-->>AxonOps: Return axon id
AxonOps-->>Developer: Return Axon object
Developer->>Axon: Publish event or subscribe stream
Axon->>RunloopAPI: Call publish or subscribe using axon id
RunloopAPI-->>Developer: Return publish result or event stream
Generated by CodeAnt AI |
Contributor
Nitpicks 🔍
|
![codeant-ai[bot]](https://avatars.githubusercontent.com/in/646884?s=60&v=4){kind=small}
Comment on lines
+160
to
+166
| const mockStream = { [Symbol.asyncIterator]: jest.fn() }; | ||
| mockClient.axons.subscribeSse.mockResolvedValue(mockStream); | ||
|
|
||
| const stream = await axon.subscribeSse(); | ||
|
|
||
| expect(mockClient.axons.subscribeSse).toHaveBeenCalledWith('axn_123456789', undefined); | ||
| expect(stream).toBe(mockStream); |
Contributor
There was a problem hiding this comment.
Suggestion: The mocked SSE stream is not a valid async iterator because its Symbol.asyncIterator returns undefined, so this test can pass while real consumer iteration would fail at runtime. Mock a real async iterator and assert it exposes next(). [possible bug]
Severity Level: Major ⚠️
- ⚠️ Axon subscribeSse test misses iterator contract validation.
- ⚠️ Iteration-time stream failures can evade unit coverage.
Suggested change
| const mockStream = { [Symbol.asyncIterator]: jest.fn() }; | |
| mockClient.axons.subscribeSse.mockResolvedValue(mockStream); | |
| const stream = await axon.subscribeSse(); | |
| expect(mockClient.axons.subscribeSse).toHaveBeenCalledWith('axn_123456789', undefined); | |
| expect(stream).toBe(mockStream); | |
| const mockStream = { | |
| [Symbol.asyncIterator]: () => ({ | |
| next: async () => ({ done: true, value: undefined }), | |
| }), | |
| }; | |
| mockClient.axons.subscribeSse.mockResolvedValue(mockStream); | |
| const stream = await axon.subscribeSse(); | |
| const iterator = stream[Symbol.asyncIterator](); | |
| expect(mockClient.axons.subscribeSse).toHaveBeenCalledWith('axn_123456789', undefined); | |
| expect(typeof iterator.next).toBe('function'); |
Steps of Reproduction ✅
1. In `tests/objects/axon.test.ts:160`, the mock stream is `{ [Symbol.asyncIterator]:
jest.fn() }`, where invoking `stream[Symbol.asyncIterator]()` returns `undefined` by
default.
2. In `tests/objects/axon.test.ts:163-166`, the test only checks that
`Axon.subscribeSse()` returns the same object and that the client method was called; it
never validates iterator behavior.
3. In real usage docs at `src/sdk/axon.ts:139-143`, consumers use `for await (const event
of stream)`, which requires a valid async iterator with `next()`.
4. Since `src/sdk/axon.ts:148-149` is a passthrough (`return
this.client.axons.subscribeSse(this._id, options)`), a malformed stream contract would not
be caught by this test and would fail only when consumers iterate.Prompt for AI Agent 🤖
This is a comment left during a code review.
**Path:** tests/objects/axon.test.ts
**Line:** 160:166
**Comment:**
*Possible Bug: The mocked SSE stream is not a valid async iterator because its `Symbol.asyncIterator` returns `undefined`, so this test can pass while real consumer iteration would fail at runtime. Mock a real async iterator and assert it exposes `next()`.
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.
Contributor
|
CodeAnt AI finished reviewing your PR. |
❌ Object Smoke Tests FailedTest Results❌ Some smoke tests failed Failed Tests:
Please fix the failing tests before checking coverage. |
sid-rl
reviewed
Mar 25, 2026
Comment on lines
+57
to
+60
| const mergedOptions: Core.RequestOptions = { | ||
| headers: defaultHeaders, | ||
| ...options, | ||
| }; |
Contributor
There was a problem hiding this comment.
doesn't this drop defaultHeaders if user provides any headers? we should make this headers: {Accept: 'text/event-stream', ...options?.headers,}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
Format:
feat[optional scope]: <description>Examples:
feat: add new SDK method·feat(storage): support file uploads·feat!: breaking API changeDescription
Motivation
Changes
Testing
Breaking Changes
Checklist
feat:orfeat(scope):)CodeAnt-AI Description
Add object-oriented Axon support to the SDK
What Changed
axonarea on the SDK for creating Axons, opening an existing Axon by ID, listing Axons, publishing events, and subscribing to event streams.Impact
✅ Can create and use Axons from the SDK✅ Can publish events and read live event streams✅ SDK users can discover and list active Axons💡 Usage Guide
Checking Your Pull Request
Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.
Talking to CodeAnt AI
Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:
This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.
Example
Preserve Org Learnings with CodeAnt
You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:
This helps CodeAnt AI learn and adapt to your team's coding style and standards.
Example
Retrigger review
Ask CodeAnt AI to review the PR again, by typing:
Check Your Repository Health
To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.