Skip to content
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.

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

feat: plugin rabbi trader tests #2520

Merged
merged 5 commits into from
Jan 19, 2025

Conversation

ai16z-demirix
Copy link
Contributor

@ai16z-demirix ai16z-demirix commented Jan 19, 2025

Relates to

#2519

Risks

Low: adding test config and tests

Background

What does this PR do?

#2519

What kind of change is this?

Features/tests

#2519

Documentation changes needed?

None

Testing

Where should a reviewer start?

Detailed testing steps

Summary by CodeRabbit

  • New Features

    • Added comprehensive test suites for various modules including dexscreener, tokenUtils, and wallet functions
    • Introduced Vitest testing framework to the project
  • Chores

    • Updated package.json with new testing scripts and dependencies
    • Added Vitest configuration file for test environment setup
  • Tests

    • Implemented detailed test coverage for data fetching, error handling, and utility functions
    • Added tests for wallet-related functionality, including keypair and balance operations

Copy link
Contributor

coderabbitai bot commented Jan 19, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/plugin-rabbi-trader/__tests__/dexscreener.test.ts

Oops! Something went wrong! :(

ESLint: 9.18.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

📝 Walkthrough

Walkthrough

This pull request introduces comprehensive test coverage for the @elizaos/plugin-rabbi-trader package using Vitest. The changes include new test suites for wallet functions, token utilities, and DexScreener data retrieval, along with configuration files to support testing. The implementation focuses on validating core functionalities, error handling, and ensuring robust behavior across different scenarios.

Changes

File Change Summary
__tests__/dexscreener.test.ts Added test suite for getDexScreenerData and analyzePair functions, covering data fetching and pair analysis
__tests__/tokenUtils.test.ts Implemented tests for loadTokenAddresses function with various scenarios like file loading and error handling
__tests__/wallet.test.ts Created test suite for wallet-related functions, testing keypair generation and balance retrieval
package.json Added Vitest dependencies and test scripts
vitest.config.ts Introduced Vitest configuration for testing environment and coverage reporting

Possibly related issues

Possibly related PRs

Finishing Touches

  • 📝 Generate Docstrings (Beta)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (6)
packages/plugin-rabbi-trader/__tests__/tokenUtils.test.ts (2)

31-38: Add test case for empty token addresses array.

Consider adding a test case to verify behavior when the JSON file contains an empty array.

it('should handle empty token addresses file', () => {
    vi.mocked(fs.readFileSync).mockReturnValue('[]');
    const addresses = loadTokenAddresses();
    expect(addresses).toEqual([]);
});

48-52: Add test case for malformed token addresses.

The current test only checks for invalid JSON. Consider adding a test for valid JSON but invalid token address format.

it('should throw error if token addresses are malformed', () => {
    vi.mocked(fs.readFileSync).mockReturnValue(JSON.stringify([123, "not-an-address"]));
    expect(() => loadTokenAddresses()).toThrow('Invalid token address format');
});
packages/plugin-rabbi-trader/__tests__/wallet.test.ts (1)

87-96: Add specific error message assertion.

The error handling test should verify the specific error message being logged.

             const balance = await getWalletBalance(mockRuntime);
             expect(balance).toBe(0);
             expect(mockConnection.getBalance).toHaveBeenCalled();
+            expect(mockRuntime.error).toHaveBeenCalledWith('Failed to get wallet balance:', expect.any(Error));
packages/plugin-rabbi-trader/__tests__/dexscreener.test.ts (2)

95-95: Extract magic numbers into named constants.

The volume and price change thresholds (10k, 5%) are hardcoded in multiple places. Extract these into named constants at the top of the test file.

const VOLUME_THRESHOLD = 10_000;
const PRICE_CHANGE_THRESHOLD = 5.0;

Also applies to: 123-123, 134-134


73-103: Reduce duplication by reusing mock data.

The mock pair data is duplicated between the Puppeteer mock and the test cases. Consider extracting it into a shared fixture.

const createMockPair = (overrides = {}) => ({
    chainId: 'solana',
    dexId: 'raydium',
    // ... rest of the mock data
    ...overrides
});
packages/plugin-rabbi-trader/package.json (1)

24-27: Add @types dependencies for better TypeScript support.

Consider adding type definitions for dependencies that don't include their own types.

     "devDependencies": {
         "vitest": "^1.2.1",
-        "@vitest/coverage-v8": "^1.2.1"
+        "@vitest/coverage-v8": "^1.2.1",
+        "@types/ws": "^8.0.0"
     },
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 319840c and 90fb888.

📒 Files selected for processing (5)
  • packages/plugin-rabbi-trader/__tests__/dexscreener.test.ts (1 hunks)
  • packages/plugin-rabbi-trader/__tests__/tokenUtils.test.ts (1 hunks)
  • packages/plugin-rabbi-trader/__tests__/wallet.test.ts (1 hunks)
  • packages/plugin-rabbi-trader/package.json (1 hunks)
  • packages/plugin-rabbi-trader/vitest.config.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/plugin-rabbi-trader/vitest.config.ts

packages/plugin-rabbi-trader/__tests__/wallet.test.ts Outdated Show resolved Hide resolved
@wtfsayo wtfsayo changed the title Feat/plugin rabbi trader tests feat: plugin rabbi trader tests Jan 19, 2025
@wtfsayo wtfsayo enabled auto-merge (squash) January 19, 2025 14:56
@wtfsayo wtfsayo self-requested a review January 19, 2025 14:56
@wtfsayo wtfsayo merged commit 5514e08 into elizaOS:develop Jan 19, 2025
6 of 8 checks passed
mgunnin added a commit to mgunnin/eliza-agent that referenced this pull request Jan 19, 2025
* upstream/develop:
  plugin-tts: enhance TTS generation flow and caching (elizaOS#2506)
  chore: add eliza technical report/paper (elizaOS#2517)
  feat: plugin rabbi trader tests (elizaOS#2520)
  Replace user ID with room ID in MemoryManager and other improvements (elizaOS#2492)
  test: plugin-tee - adjusting project structure and new tests (elizaOS#2508)
  fix: use header key from api config (elizaOS#2518)
  docs: add docs/README_JA.md (elizaOS#2515)
  AgentKit - Default Agent Config (elizaOS#2505)
  feat(plugin-openai): add OpenAI integration for text generation (elizaOS#2463)
  feat: add support for NVIDIA inference for ElizaOS (elizaOS#2512)
  test: api timeout handling for plugin-binance (elizaOS#2504)
  Replace type assertions
  Replace type assertions
  destroy file system after sending media
  support multimedia
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants