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: tests for supabase and sqlite db adapters #2468

Merged
merged 8 commits into from
Jan 18, 2025

Conversation

ai16z-demirix
Copy link
Contributor

Relates to

#2467

Risks

Low: adding tests

Background

What does this PR do?

#2467

What kind of change is this?

features/tests

Documentation changes needed?

None

Testing

Where should a reviewer start?

packages/adapter-sqlite
packages/adapter-supabase

Detailed testing steps

pnpm install in root
navigate to desired directories to see tests
run pnpm test to run tests

Copy link
Contributor

coderabbitai bot commented Jan 17, 2025

📝 Walkthrough

Walkthrough

The pull request introduces comprehensive testing infrastructure for SQLite and Supabase database adapters using Vitest. It adds test suites for SqliteDatabaseAdapter and SupabaseDatabaseAdapter, covering methods like room retrieval, participant management, and user state handling. The changes include new configuration files, package scripts, and detailed unit tests to ensure robust functionality across different database adapter implementations.

Changes

File Change Summary
packages/adapter-sqlite/__tests__/sqlite-adapter.test.ts Added comprehensive Vitest test suite for SqliteDatabaseAdapter covering room, participant, and user state methods
packages/adapter-sqlite/package.json Added Vitest-related dev dependencies and testing scripts
packages/adapter-sqlite/vitest.config.ts Created Vitest configuration file with node environment settings
packages/adapter-supabase/__tests__/supabase-adapter.test.ts Added comprehensive Vitest test suite for SupabaseDatabaseAdapter with method-specific tests
packages/adapter-supabase/package.json Added Vitest-related dev dependencies and testing scripts
packages/adapter-supabase/vitest.config.ts Created Vitest configuration file with node environment settings

Possibly related issues

  • elizaOS/eliza#2467: Directly addresses the issue's request for adding tests to SQLite and Supabase database adapters, providing comprehensive test coverage in the __tests__ directory

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: 0

🧹 Nitpick comments (7)
packages/adapter-sqlite/__tests__/sqlite-adapter.test.ts (1)

8-16: Consider using a dedicated mock file for elizaLogger.

The inline mock could be moved to a separate mock file to improve maintainability.

packages/adapter-supabase/package.json (1)

26-29: Lock the Vitest dependency versions.

Using caret ranges (^) for test dependencies can lead to inconsistent test behavior. Consider using fixed versions.

-        "@vitest/coverage-v8": "^3.0.2",
-        "@vitest/ui": "^0.34.7",
-        "vitest": "^3.0.2"
+        "@vitest/coverage-v8": "3.0.2",
+        "@vitest/ui": "0.34.7",
+        "vitest": "3.0.2"
packages/adapter-sqlite/package.json (1)

29-31: Lock the Vitest dependency versions.

Similar to the Supabase adapter, use fixed versions for test dependencies.

-        "vitest": "^3.0.2",
-        "@vitest/coverage-v8": "^3.0.2",
-        "@vitest/ui": "^3.0.2"
+        "vitest": "3.0.2",
+        "@vitest/coverage-v8": "3.0.2",
+        "@vitest/ui": "0.34.7"
packages/adapter-supabase/__tests__/supabase-adapter.test.ts (4)

10-11: Consider using a more type-safe approach instead of type assertion.

Replace ...actual as any with proper type definitions to maintain type safety.

- ...actual as any,
+ ...(actual as typeof import('@elizaos/core')),

46-47: Avoid @ts-ignore by properly typing the mock.

Instead of using @ts-ignore, consider defining proper types for the mock implementation.

- // @ts-ignore - we're mocking the implementation
- adapter.supabase = mockSupabase;
+ (adapter as any).supabase = mockSupabase; // TODO: Consider exposing a protected property for testing

103-141: Add test for empty participants array.

Consider adding a test case where the query returns an empty array to ensure proper handling of users with no participants.

it('should return empty array when user has no participants', async () => {
    mockSupabase.eq.mockResolvedValueOnce({ 
        data: [],
        error: null 
    });

    const userId = 'user-no-participants' as UUID;
    const result = await adapter.getParticipantsForAccount(userId);
    
    expect(result).toEqual([]);
});

223-225: Enhance error message with more details.

The current error message could be more informative by including the error details.

- .toThrow('Failed to set participant user state');
+ .toThrow(`Failed to set participant user state: ${error.message}`);
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d666e48 and e79b0f3.

📒 Files selected for processing (6)
  • packages/adapter-sqlite/__tests__/sqlite-adapter.test.ts (1 hunks)
  • packages/adapter-sqlite/package.json (1 hunks)
  • packages/adapter-sqlite/vitest.config.ts (1 hunks)
  • packages/adapter-supabase/__tests__/supabase-adapter.test.ts (1 hunks)
  • packages/adapter-supabase/package.json (1 hunks)
  • packages/adapter-supabase/vitest.config.ts (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • packages/adapter-supabase/vitest.config.ts
  • packages/adapter-sqlite/vitest.config.ts
🔇 Additional comments (4)
packages/adapter-sqlite/__tests__/sqlite-adapter.test.ts (2)

72-99: Add edge case tests for getParticipantsForAccount.

The current tests cover basic scenarios but miss important edge cases:

  • Invalid user ID
  • Database errors

159-170: Add error handling tests for init and close methods.

The current tests only verify successful scenarios. Add tests for:

  • Database initialization failures
  • Connection closure errors
packages/adapter-supabase/__tests__/supabase-adapter.test.ts (2)

56-101: Well-structured test suite for getRoom!

Good coverage of success, failure, and error cases with proper assertions.


143-191: Excellent test coverage for getParticipantUserState!

Good handling of mock chains and verification of multiple eq calls.

@shakkernerd shakkernerd changed the title tests for db adapters: supabase and sqlite feat: tests for supabase and sqlite db adapters Jan 18, 2025
@shakkernerd shakkernerd merged commit 486c9d4 into elizaOS:develop Jan 18, 2025
4 checks passed
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