feat: add proper support for JSON Schemas on workflows

[UlisesGascon]

Related #1 and OpenPathfinder/visionBoard#251

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of input data for the workflow execute command to ensure proper JSON parsing and validation.
  • Added clearer error messages when required workflow data is missing or when the workflow lacks a defined JSON schema.

[coderabbitai]

Warning

Rate limit exceeded

@UlisesGascon has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 22 minutes and 49 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 025b259 and 724e941.

📒 Files selected for processing (1)

• src/index.ts (2 hunks)

Walkthrough

The update changes how input data is processed for the workflow execute command. Input provided via the -d option is now parsed as JSON immediately. Additional checks ensure that required data cannot be provided without a defined JSON schema, and both input data and schema are parsed as JSON before validation.

Changes

File(s)	Change Summary
src/index.ts	Modified input data handling: parses -d input as JSON, checks for schema presence, and parses schema as JSON before validation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Workflow

    User->>CLI: Execute workflow with -d or -f input
    CLI->>CLI: Parse input data as JSON
    CLI->>Workflow: Check if workflow requires data
    alt Data required but no schema
        CLI->>User: Throw API error
    else Schema present
        CLI->>CLI: Parse schema as JSON
        CLI->>CLI: Validate data against schema
        CLI->>Workflow: Execute workflow
        Workflow-->>CLI: Return result
        CLI-->>User: Output result
    end

Loading

Possibly related PRs

• feat: add command workflow execute #9: Introduces the initial workflow execute command and related logic, which this PR directly refines and builds upon.

Poem

A rabbit with JSON in paw,
Hops through workflows, without a flaw.
Data parsed neat, schemas in tow,
Errors caught early, onward we go!
🐇✨

✨ 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

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

[coderabbitai]

Actionable comments posted: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 14ab0fd and 025b259.

📒 Files selected for processing (1)

• src/index.ts (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: Test on windows-latest with Node 24.x
• GitHub Check: Test on macOS-latest with Node 24.x
• GitHub Check: Test on windows-latest with Node 20.x
• GitHub Check: Test on windows-latest with Node 22.x
• GitHub Check: Analyze (actions)
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (1)

src/index.ts (1)

73-75: Good defensive programming practice.

The validation ensures that workflows requiring additional data have a proper schema defined, preventing runtime errors during validation.