fix: remote url in config is read as file #1830

laststylebender14 · 2024-05-01T14:53:11Z

Summary:

Fixes the problem when remote url is provided in link directive.
added check on resolve_path method which returns the valid path to caller.
enabled time and io on tokio.
updated test cases for resolve_path function.

Issue Reference(s):
Fixes #1793

Build & Testing:

I ran cargo test successfully.
I have run ./lint.sh --mode=fix to fix all linting issues raised by ./lint.sh --mode=check.

Checklist:

I have added relevant unit & integration tests.
I have updated the documentation accordingly.
I have performed a self-review of my code.
PR follows the naming convention of <type>(<optional scope>): <title>

- fix: added check for url and if it's url then return url as is.

coderabbitai · 2024-05-01T14:53:18Z

Walkthrough

The update enhances the configuration reader to handle both local and remote file paths, making the software more versatile. Additionally, it extends the main execution function to support advanced time and I/O operations, improving overall functionality for file handling.

Changes

File	Change Summary
`src/config/reader.rs`	Modified `resolve_path` to handle "http" paths in addition to absolute and relative paths.
`src/main.rs`	Updated `run_blocking()` to include `.enable_time()` and `.enable_io()` for improved operation support.

Assessment against linked issues

Objective	Addressed	Explanation
Bug fix for handling remote URLs in config instead of reading from file system (#1793)	✅
Ensure config reader checks if `src` is a URL before resolving as a file system path (#1793)	✅
Add execution_spec test for remote URL handling in config (#1793)	❌	The PR does not introduce a new test in execution_spec to validate the handling of remote URLs.

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

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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.

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 as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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: 1

coderabbitai · 2024-05-01T14:56:08Z

src/config/reader.rs

+    /// checks and returns valid path for caller function.
    fn resolve_path(src: &str, root_dir: Option<&Path>) -> String {
-        if Path::new(&src).is_absolute() {
+        if src.starts_with("http") || Path::new(&src).is_absolute() {


The update to resolve_path to handle URLs starting with "http" is a necessary fix for the issue identified. Consider adding a unit test to ensure that URLs are correctly recognized and not treated as local paths.

Would you like me to help generate the unit testing code or open a GitHub issue to track this task?

can we add some tests for this @ranjitmahadik

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

@tusharmath sure, will add test cases for the change.

tusharmath · 2024-05-01T15:04:49Z

src/config/reader.rs

@@ -213,10 +214,11 @@ impl ConfigReader {
        Ok(config_module)
    }

-    /// Checks if path is absolute else it joins file path with relative dir
-    /// path
+    /// checks and returns valid path for caller function.


I think the older documentation was more detailed.

kept most of contents same and extended for urls, please let me know if this works for you or not.

/// Checks if path is a URL or absolute path, returns directly if so. /// Otherwise, it joins file path with relative dir path.

src/config/reader.rs

laststylebender14 added 2 commits May 1, 2024 19:49

- issue: urls were treated as normal file path.

c9f10d9

- fix: added check for url and if it's url then return url as is.

- enabled time and io to fix the errors.

8410bfd

github-actions bot added the type: fix Iterations on existing features or infrastructure. label May 1, 2024

coderabbitai bot reviewed May 1, 2024

View reviewed changes

- use Url::parse to determine the existance of url.

78c4566

tusharmath reviewed May 1, 2024

View reviewed changes

laststylebender14 and others added 3 commits May 1, 2024 22:31

- added test for testing remote url path.

de2dfd1

- instead of string literal use already defined string var.

c428e89

Merge branch 'main' into bug/fix-remote-url-for-link-directive

2dad388

tusharmath reviewed May 2, 2024

View reviewed changes

src/config/reader.rs Show resolved Hide resolved

tusharmath marked this pull request as draft May 2, 2024 14:48

laststylebender14 marked this pull request as ready for review May 2, 2024 15:29

tusharmath changed the title ~~fix: When specifying remote url in config cli tries to read file from FS~~ fix: remote url in config is read as file May 2, 2024

tusharmath approved these changes May 2, 2024

View reviewed changes

tusharmath merged commit fc96336 into tailcallhq:main May 2, 2024
28 of 29 checks passed

ssddOnTop pushed a commit that referenced this pull request May 2, 2024

fix: remote url in config is read as file (#1830)

aa907b8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: remote url in config is read as file #1830

fix: remote url in config is read as file #1830

laststylebender14 commented May 1, 2024 •

edited

Loading

coderabbitai bot commented May 1, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot May 1, 2024 •

edited

Loading

tusharmath May 1, 2024

coderabbitai bot May 1, 2024

laststylebender14 May 1, 2024

tusharmath May 1, 2024

laststylebender14 May 1, 2024

fix: remote url in config is read as file #1830

fix: remote url in config is read as file #1830

Conversation

laststylebender14 commented May 1, 2024 • edited Loading

coderabbitai bot commented May 1, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot May 1, 2024 • edited Loading

Choose a reason for hiding this comment

tusharmath May 1, 2024

Choose a reason for hiding this comment

coderabbitai bot May 1, 2024

Choose a reason for hiding this comment

laststylebender14 May 1, 2024

Choose a reason for hiding this comment

tusharmath May 1, 2024

Choose a reason for hiding this comment

laststylebender14 May 1, 2024

Choose a reason for hiding this comment

laststylebender14 commented May 1, 2024 •

edited

Loading

coderabbitai bot commented May 1, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

coderabbitai bot May 1, 2024 •

edited

Loading