Update db interactions and tests

[diegoalzate]

overview

• makes a distinction between db connections and db schema. keeping all schema tables inside db/schema and db functions in db
• changes test runner from jest to node:test so we can remove a dependency
• adds a helper function for tests

  const { dbClient, teardown } = await createTestDatabase(envVariables);

  this will create an ephemeral database and will return a way to delete this database. allowing now tests to run concurrently without race conditions because each test will run in its own db.

performance

all ran on a m1 mac

with jest

with node:test

with node:test and ephemeral dbs

Summary by CodeRabbit

• New Features

  • Introduced a new .nycrc configuration for code coverage tailored for TypeScript projects.
  • Added a test database setup functionality to enhance isolated testing environments.

• Bug Fixes

  • Updated test scripts to prevent errors by ensuring necessary environment files are created before test execution.

• Refactor

  • Streamlined database schema references across handlers and services to use a new schema structure.

• Tests

  • Transitioned assertion methods in test files to use Node.js's built-in assert module for improved consistency and clarity.

• Chores

  • Updated various import statements for better organization and clarity throughout the codebase.

[diegoalzate]

@coderabbitai summary

[coderabbitai[bot]]

Actions performed

Summary regeneration triggered.

[coderabbitai[bot]]

Walkthrough

This update introduces a comprehensive restructuring of the database access patterns across the application. It shifts from using a generalized db module to a more specific schema module, enhancing type safety and clarity in database interactions. Additionally, testing methodologies have been revised to utilize dedicated test databases, improving isolation and reliability. These changes collectively aim to streamline code organization, improve maintainability, and clarify the underlying data models used throughout the application.

Changes

Files	Change Summary
.github/workflows/test.yml, .gitignore, .nycrc	Adjustments to testing environment setup, exclusions for test artifacts, and introduction of code coverage configurations for better test management.
drizzle.config.js, src/db/create-db-connection.ts, src/db/index.ts, src/db/schema/index.ts, src/db/test.ts, src/handlers/*, src/routers/*, src/services/*	Major refactor to replace db module usage with schema, updating all references and types for improved clarity and maintainability in database interactions.
package.json	Changes in test commands and dependencies, transitioning from Jest to NYC for coverage measurement and removing unnecessary Jest dependencies.
scripts/db/seed.ts, src/db/seed.ts	New database seeding functionality designed for structured data insertion and cleanup operations, enhancing development and testing efficiency.
src/modules/*.spec.ts	Transition to Node.js's native assert module for consistency in assertions, aligning with a more structured testing approach.

Sequence Diagram(s)

sequenceDiagram
    participant A as User
    participant B as Router
    participant C as Schema
    participant D as Database

    A->>B: Request data
    B->>C: Query schema for data
    C->>D: Fetch data from database
    D-->>C: Return data
    C-->>B: Return formatted data
    B-->>A: Send response

Poem

🐇 In fields of code where bunnies hop,
New schemas bloom, no need to stop.
With tests now spry and coverage bright,
We celebrate changes, oh what a sight!
Each line refined, each path made clear,
Hoppy coding days, let's give a cheer! 🎉

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.