Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG]: URL Parsing And Validation #1118

Merged

Conversation

tazarov
Copy link
Contributor

@tazarov tazarov commented Sep 8, 2023

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • Added additional validations to URLs - URLs like api-gw.aws.com/dev will now trigger an error asking the user to correctly specify the URL with http or https
    • When the full URL (http(s)://example.com) is provided by the user, the port parameter is ignored (debug message is logged). An assumption is made that the URL is entirely defined, thus not requiring additional alterations such as injecting the port.
    • Added negative test cases for invalid URLs

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python

Documentation Changes

TBD

- Added additional validations to URLs - urls like api-gw.aws.com/dev will now trigger an error asking the user to properly specify the URL with http or https
- When full URL (http(s)://example.com) is provided by the user port parameter is ignored (debug message is logged). An assumption is made that the URL is defined in its entirety thus not requiring additional alterations such as injecting the port.
- Added negative test cases for invalid urls
@github-actions
Copy link

github-actions bot commented Sep 8, 2023

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readbility, Modularity, Intuitiveness)

@tazarov
Copy link
Contributor Author

tazarov commented Sep 8, 2023

This is in response to discord discussion: https://discord.com/channels/1073293645303795742/1149296346109575188

@HammadB HammadB merged commit 9c1979c into chroma-core:main Sep 11, 2023
tazarov added a commit to amikos-tech/chroma-core that referenced this pull request Sep 21, 2023
## Description of changes

*Summarize the changes made by this PR.*
 - Improvements & Bug fixes
- Added additional validations to URLs - URLs like api-gw.aws.com/dev
will now trigger an error asking the user to correctly specify the URL
with http or https
- When the full URL (http(s)://example.com) is provided by the user, the
port parameter is ignored (debug message is logged). An assumption is
made that the URL is entirely defined, thus not requiring additional
alterations such as injecting the port.
    - Added negative test cases for invalid URLs

## Test plan
*How are these changes tested?*

- [x] Tests pass locally with `pytest` for python

## Documentation Changes
TBD
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants