feat: added middleware() API, types & tests

[jimezesinachi]

SynthQL pull request template

Why

We want to make it possible for users to pass a set of middleware that can be used to transform matching queries

What changed

A new middleware() function, a Middleware interface, and changes to QueryEngine.execute()

Important

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced middleware functionality for query transformations, enhancing the flexibility of the Query Engine.
  • Added a new factory function for creating instances of the Query Engine with optional middleware.

• Bug Fixes

  • Improved error handling in the response generation for streaming data, ensuring structured error reporting.

• Documentation

  • Enhanced documentation for existing properties and added examples for clarity.

• Tests

  • Added tests for the new middleware functionality, ensuring expected behavior for query restrictions based on user roles.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 15, 2024 7:52am

[fhur]

Looks mostly what I would have expected, good job jim 👍

[fhur]

LGTM!

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request primarily enhance the QueryEngine and introduce middleware functionality to allow for query transformations. A new middlewares property is added to the QueryEngineProps interface, enabling users to specify middleware functions that modify queries before execution. The QueryEngine class is updated to store and apply these middleware functions during query execution. Additionally, new middleware handling interfaces and functions are introduced, along with tests to validate the middleware's behavior. Documentation improvements accompany these changes to clarify the new functionality.

Changes

File Path	Change Summary
packages/backend/src/QueryEngine.ts	- Added middlewares?: Array<Middleware<any, any>> to QueryEngineProps interface. - Declared private middlewares property in QueryEngine class. - Updated execute and executeAndWait methods to accept a context and apply middleware logic.
packages/backend/src/execution/middleware.ts	- Added Middleware interface and middleware function for creating middleware. - Defined predicate and transformQuery properties in the Middleware interface.
packages/backend/src/execution/middleware.test.ts	- Introduced tests for restrictPaymentsByCustomer middleware, validating its behavior with user roles and session context.
packages/backend/src/index.ts	- Added export statement for middleware from ./execution/middleware.
packages/backend/src/tests/queryEngine.ts	- Replaced direct export of QueryEngine with createQueryEngine function to allow middleware inclusion.
packages/backend/src/tests/benchmarks/bench.test.ts	- Updated to instantiate queryEngine using createQueryEngine().
packages/backend/src/tests/e2e/select.test.ts	- Changed instantiation of queryEngine to use createQueryEngine().
packages/backend/src/tests/propertyBased/properties/*.test.ts	- Updated all property-based tests to instantiate queryEngine using createQueryEngine().
packages/docs/static/reference/assets/navigation.js	- Updated window.navigationData with a new base64-encoded string.
packages/docs/static/reference/assets/search.js	- Updated window.searchData with a new base64-encoded string.
packages/handler-next/src/createNextSynthqlHandler.ts	- Enhanced error handling and response generation in createNextSynthqlHandler function. - Updated function signature to return NextSynthqlHandler.
packages/introspect/src/tests/pg_types.test.ts	- Modified comments and import statements, clarifying context without changing test logic.

Possibly related PRs

• feat: added hashQuery() and used it in useSynthql() #41: The changes in this PR involve the addition of a hash property to queries, which may relate to the new middleware functionality in the main PR that allows for query transformations.
• Deferred queries #52: This PR introduces support for deferred queries, which could be relevant to the middleware functionality that transforms queries before execution in the main PR.
• feat: updated shouldYield() #54: The updates to the shouldYield() function for deferred queries are directly related to the enhancements made in the main PR regarding query execution and middleware processing.

🐰 In the land of code where queries flow,
A middleware dance begins to grow.
Transforming queries with a gentle touch,
Making them better, oh so much!
With tests to ensure they work just right,
Our QueryEngine shines, oh what a sight! 🌟

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.