plane icon indicating copy to clipboard operation
plane copied to clipboard

Feat api testing with devzery

Open nitishvarmaus opened this issue 9 months ago • 2 comments

This pull request introduces a new middleware to integrate Devzery into the project. The most important changes include adding the DevzeryDjangoMiddleware to the middleware settings and including the devzery package in the project dependencies.

Integration with Devzery:

  • apiserver/plane/settings/common.py: Added DevzeryDjangoMiddleware to the middleware list and included placeholders for DEVZERY_API_KEY and DEVZERY_SERVER_NAME settings.
  • apiserver/requirements/base.txt: Added devzery==0.1.0 to the list of project dependencies.

Description

Type of Change

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [x] Feature (non-breaking change which adds functionality)
  • [ ] Improvement (change that would cause existing functionality to not work as expected)
  • [ ] Code refactoring
  • [ ] Performance improvements
  • [ ] Documentation update

Screenshots and Media (if applicable)

Test Scenarios

Ran Plane and tested out the APIs if they are working fine with Devzery

References

Summary by CodeRabbit

  • New Features
    • Introduced two new configurable options for enhanced service integration.
    • Integrated an additional middleware to improve request handling and logging.
    • Added a new dependency to support these upgrades.

nitishvarmaus avatar Mar 17 '25 16:03 nitishvarmaus

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

:white_check_mark: sriramveeraghanta
:x: nitishvarmaus
You have signed the CLA already but the status is still pending? Let us recheck it.

CLAassistant avatar Mar 17 '25 16:03 CLAassistant

Walkthrough

The pull request introduces two new configuration variables, DEVZERY_API_KEY and DEVZERY_SERVER_NAME, in the settings file, both initialized as empty strings. Additionally, the middleware stack now includes the devzery.django.middleware.DevzeryDjangoMiddleware. A new dependency, devzery==0.1.0, has also been added to the requirements file. These changes adjust configuration and dependency management without altering the overall structure.

Changes

File(s) Change Summary
apiserver/plane/.../common.py Added DEVZERY_API_KEY and DEVZERY_SERVER_NAME configuration variables; inserted "devzery.django.middleware.DevzeryDjangoMiddleware" into middleware.
apiserver/requirements/base.txt Added new dependency: devzery==0.1.0.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant MW as DevzeryMiddleware
    participant V as View

    C->>MW: Send Request
    MW->>V: Process Request
    V->>MW: Return Response
    MW->>C: Send Response

Poem

I'm a rabbit in the code field, hopping with delight,
New keys and middleware make my day so bright,
Dependencies line up like carrots in a row,
With every change, our app begins to grow,
Hopping through the code till everything's just right!

[!TIP]

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments. - To enable this feature, set early_access to true under in the settings.
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
  • @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.

coderabbitai[bot] avatar Mar 17 '25 16:03 coderabbitai[bot]

We're closing this PR as devzery does not meet the open source standards we maintain for this repository. Our community repository does not rely on proprietary applications, and we need to ensure all contributions align with this principle.

Thank you for your interest in contributing. If you'd like to make future contributions that align with our open source standards, we welcome your participation.

sriramveeraghanta avatar Mar 24 '25 07:03 sriramveeraghanta