Skip to content
This repository was archived by the owner on Feb 8, 2026. It is now read-only.

return new field in response#138

Merged
johnnyluo merged 2 commits into
mainfrom
137-new-scheduling-payroll-side
Jul 23, 2025
Merged

return new field in response#138
johnnyluo merged 2 commits into
mainfrom
137-new-scheduling-payroll-side

Conversation

@webpiratt

@webpiratt webpiratt commented Jul 23, 2025

Copy link
Copy Markdown
Contributor

Ref: #137

image

Summary by CodeRabbit

  • New Features

    • Enhanced recipe configuration validation with schema compilation and error handling.
    • Improved plugin recipe specification endpoints to provide more informative error messages.
    • Added configuration options for payroll scheduling with validation and error handling.
  • Bug Fixes

    • Added error handling for recipe specification retrieval in multiple plugins, resulting in more robust plugin behavior.
  • Chores

    • Updated and added several dependencies to improve stability and compatibility.
    • Removed an unused constant related to ERC20 ABI.
    • Removed an obsolete API endpoint for policy schema.

@webpiratt webpiratt linked an issue Jul 23, 2025 that may be closed by this pull request
@coderabbitai

coderabbitai Bot commented Jul 23, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

The changes introduce error handling for recipe specification retrieval across multiple plugins, update several method signatures to return errors, and add a utility for validating JSON schemas. A plugin constant file is deleted, a new dependency for JSON schema validation is added, and a server endpoint is removed. Imports and configuration schema construction are also updated.

Changes

File(s) Change Summary
api/plugin.go Added error handling to GetRecipeSpecification, returning HTTP 500 on error.
api/server.go Removed route handler registration for /plugin/policy/schema endpoint.
go.mod Added github.com/kaptinlin/jsonschema v0.4.6 and updated several dependencies.
internal/plugin/plugin.go Added RecipeConfiguration function for JSON schema validation and conversion.
plugin/common/constants.go Deleted file containing the Erc20ABI constant.
plugin/dca/dca.go Changed GetRecipeSpecification to return (*rtypes.RecipeSchema, error).
plugin/fees/policy.go Updated GetRecipeSpecification to return an error; updated ValidatePluginPolicy accordingly.
plugin/payroll/policy.go Modified ValidatePluginPolicy to handle errors from GetRecipeSpecification.
plugin/payroll/transaction.go Updated GetRecipeSpecification to return an error, build config schema with validation.

Sequence Diagram(s)

sequenceDiagram
    participant API as API Handler
    participant Plugin as Plugin (DCA/Fee/Payroll)
    participant Util as RecipeConfiguration Utility

    API->>Plugin: GetRecipeSpecification()
    Plugin->>Util: RecipeConfiguration(jsonSchema)
    Util-->>Plugin: structpb.Struct | error
    Plugin-->>API: RecipeSchema | error
    API-->>Client: HTTP 200 with schema or HTTP 500 on error
Loading

Estimated code review effort

3 (~40 minutes)

Poem

In fields of code, a rabbit hops,
With error checks and schema stops.
Old constants gone, new helpers found,
The plugins’ voices now resound.
Dependencies bloom, endpoints prune,
Reviewers, hop in—don’t snooze too soon!
🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c8cea5d and 32f5a9d.

📒 Files selected for processing (1)
  • plugin/fees/policy.go (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • plugin/fees/policy.go
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build
✨ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

@johnnyluo johnnyluo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@johnnyluo
johnnyluo merged commit 4c39122 into main Jul 23, 2025
3 checks passed
@johnnyluo
johnnyluo deleted the 137-new-scheduling-payroll-side branch July 23, 2025 21:53
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Apply scheduling changes on Payroll side

2 participants