CLI Fixes / NPM dependency updates

[cvs0]

trafficstars

CLI Fixes / NPM Dependency Updates

Summary of items Affected

• _parse_type_annotation: Enhanced validation for argument metadata.
• parse_action: Improved checks for decorators and their arguments.
• connect cli command, improved config reading.

Type of change

• [x] Bug fix (non-breaking change which fixes an issue)

Mandatory Tasks

• [x] Make sure you have self-reviewed the code. A decent size PR without self-review might be rejected.

Checklist

• I haven't read the contributing guide
• My code doesn't follow the style guidelines of this project
  • Inside web: npm run prettier
  • Inside docs: pnpm prettier
  • Inside workflow-runner: cargo fmt
• I haven't commented my code, particularly in hard-to-understand areas
• I haven't checked if my PR needs changes to the documentation
• I haven't checked if my changes generate no new warnings (npm run lint)
• I haven't added tests that prove my fix is effective or that my feature works
• I haven't checked if new and existing unit tests pass locally with my changes
  • Inside backend: poetry run pytest
  • Inside workflow-runner: cargo test

Summary by CodeRabbit

• Refactor
  • Enhanced connectivity commands to improve the handling of user settings during connection and disconnection operations.
  • Improved custom action processing to provide clearer feedback when required configuration parameters are missing.
  • These enhancements contribute to a more intuitive and robust user experience.

[vercel[bot]]

@cvs0 is attempting to deploy a commit to the Admyral Team on Vercel.

A member of the Team first needs to authorize it.

[CLAassistant]

All committers have signed the CLA.

[vercel[bot]]

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

Name	Status	Preview	Comments	Updated (UTC)
admyral-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 22, 2024 7:37pm

[danielgrittner]

@cvs0 Just checking in: do you plan to work on the requested changes any time soon? otherwise I'll take this over

[coderabbitai[bot]]

Walkthrough

The changes introduce dedicated functions to load and save user configuration from a YAML file in the CLI module, replacing inline file operations in both the connect and disconnect commands. Additionally, the action parser in the compiler module has been restructured to provide more flexible validation for the @action decorator, including stricter checks for decorator arguments and type annotations. These modifications streamline the code by abstracting file handling and improving decorator validation with enhanced error handling.

Changes

File(s)	Change Summary
admyral/cli/connect.py	Added load_config() and save_config(config) functions to encapsulate YAML file operations; replaced inline configuration reading/writing and key removals in the connect and disconnect commands.
admyral/compiler/.../action_parser.py	Restructured parse_action for flexible validation of the @action decorator, enforcing decorator argument types and presence of keywords, and updated _parse_type_annotation to ensure metadata presence and correct variable naming.

Sequence Diagram(s)

sequenceDiagram
  participant U as User
  participant C as Connect/Disconnect Command
  participant L as load_config()
  participant Y as YAML File
  participant S as save_config()

  U->>C: Invoke connect/disconnect command
  C->>L: Call load_config()
  L->>Y: Read configuration data
  Y-->>L: Return parsed config
  L-->>C: Provide config
  alt Command modifies config
    C->>C: Update configuration (e.g., pop keys)
    C->>S: Call save_config(updated config)
    S->>Y: Write configuration data
    Y-->>S: Confirm write
    S-->>C: Finish saving
  end

sequenceDiagram
  participant P as parse_action()
  participant D as Decorator List
  participant V as Validator
  participant E as Error Handler

  P->>D: Iterate to locate @action decorator
  alt Valid @action found
    P->>V: Check for call form and keywords
    alt Keywords exist and are valid
      V-->>P: Process and return parsed action
    else Missing keywords
      P->>E: Raise ValueError for missing keywords
    end
  else
    P->>E: Raise ValueError for missing @action decorator
  end

Poem

I’m a rabbit coding through the night,
Hopping on changes with pure delight.
New functions dance in YAML’s gentle light,
Decorators prance with validations tight.
In the burrow of code, each fix feels right,
Nibbling on logic, my heart takes flight.
🐇✨ Happy hops and bug-free bytes!

✨ Finishing Touches

• [ ] 📝 Generate Docstrings (Beta)

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.