Adds the file-root in the hurl cli command if there is a file or Mult…

Xouzoura commented 2 weeks ago

Simple change to allow usage of the CWD with hurl to use endpoints that require uploading files.

WHAT

Adding the functionality to use local files of the project with hurl through the --file-root command. Example

POST {{HOST}}/upload/{{GROUP}}/{{CONVERSATION}}/ad_hoc/upload
Authorization: Bearer {{BEARER}}
[MultipartFormData]
file: file,src/tests/files/doc1.pdf;type=application/pdf
url: ""

should work now.

Link to issue

WHY

Hurl does not allow by default usage of documents if the path is not specified.

HOW

Adding current path to the hurl if there is a file uploaded (Multipart + file must exist). However modification is needed if there is a need for documents not within the project.

Screenshots (if appropriate):

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[ ] Linter
[ ] Tests
[ ] Review comments
[ ] Security

[!IMPORTANT] Adds --file-root option to hurl command for file uploads using CWD.

Behavior:

Adds --file-root with CWD to hurl command if file upload is detected in execute_hurl_cmd() in main.lua.

Uses has_file_in_opts() in utils.lua to check for file uploads in options.

Functions:

Adds has_file_in_opts() in utils.lua to determine if options include file uploads.

Misc:

Updates execute_hurl_cmd() in main.lua to extend command with --file-root when necessary.

^{This description was created by}^{for 985ae22e2a264a98ef712e9b8215a40a8906e693. It will automatically update as commits are pushed.}

Summary by CodeRabbit

New Features
- Introduced a command option to specify a file root based on the current directory when a file option is included.
- Added functionality to check for file paths in command options, enhancing error handling and validation.
- Enhanced output handling to support JSON responses and improved logging.
Bug Fixes
- Improved error messaging for missing or inaccessible file paths in command options.

codesandbox[bot] commented 2 weeks ago

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders
Open Preview

changeset-bot[bot] commented 2 weeks ago

⚠️ No Changeset found

Latest commit: 1ef08c934f7cc93462b14fc2896e870aca450a85

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes introduce a new boolean variable is_file_mode in the lua/hurl/main.lua file, which checks for a file option in the command options. If a file option is present, it appends a --file-root option to the command with the current working directory. Additionally, a new function util.has_file_in_opts is added in lua/hurl/utils.lua, which verifies the presence of a file path in the options and checks its content for specific keywords.

Changes

Files	Change Summary
lua/hurl/main.lua	Added variable `local is_file_mode` to check for file options and modify the command accordingly. Updated output handling to include checks for the `--json` flag.
lua/hurl/utils.lua	Introduced function `util.has_file_in_opts(opts)` to check for file paths in options and validate them.

Poem

In the burrow, changes sprout,
A file mode to check, no doubt!
With options in hand, we dance and play,
Hurling commands in a clever way.
A hop, a skip, a joyful cheer,
For every file, we hold so dear! 🐇✨

📜 Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

📥 Commits

Files that changed from the base of the PR and between 47478d6e8d8dff9d218db60a9348838b6e842c6a and 1ef08c934f7cc93462b14fc2896e870aca450a85.

📒 Files selected for processing (1)

* lua/hurl/utils.lua (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

* lua/hurl/utils.lua

--- 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

jellydn commented 2 weeks ago

@all-contributors add @Xouzoura for code.

allcontributors[bot] commented 2 weeks ago

@jellydn

I've put up a pull request to add @Xouzoura! :tada:

jellydn / hurl.nvim