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.

Sign up for GitHub

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

Jump to bottom

[ENH] Always pass Tenant and DB as query params #1558

Open
wants to merge 21 commits into
base: main
Choose a base branch
from
Open

[ENH] Always pass Tenant and DB as query params #1558

wants to merge 21 commits into from
+4,567 −235

Conversation

beggers
Copy link
Contributor

@beggers beggers commented Dec 20, 2023

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • Always pass tenant and db as query params. This makes db-scoped auth tokens cleaner since we no longer overwrite the request's specified tenant and db -- we only overwrite them if they're not set.
    • As part of this, we can delete the CreateTenant and CreateDatabase type and some auth code which only existed because of their existence.

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

@github-actions GitHub Actions
Copy link

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)

beggers
beggers commented Dec 20, 2023
View reviewed changes
chromadb/auth/fastapi_utils.py
for key, value in kwargs.items():
if type == AuthzResourceTypes.DB and isinstance(value, CreateDatabase):
return dict(value)
elif type == AuthzResourceTypes.COLLECTION and isinstance(
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: this was never used in the AuthzResourceTypes.COLLECTION case

beggers
beggers commented Dec 21, 2023
View reviewed changes
chromadb/auth/fastapi.py
kwargs["database"] = desired_database
elif isinstance(kwargs["database"], chromadb.server.fastapi.types.CreateDatabase):
kwargs["database"].name = desired_database
if not request:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the only change to this file: remove a layer of indentation to make the code marginally cleaner

@beggers beggers changed the title Always pass Tenant and DB as query params [ENH] Always pass Tenant and DB as query params Jan 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@beggers