Skip to content

fix: The interface for obtaining model metadata cannot access public models #2787

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

Merged
shaohuzhang1 merged 1 commit into from
Apr 2, 2025
Merged

fix: The interface for obtaining model metadata cannot access public models #2787

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion apps/setting/serializers/provider_serializers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,14 +313,16 @@ def one(self, with_valid=False):
return ModelSerializer.model_to_dict(model)

def one_meta(self, with_valid=False):
model = None
if with_valid:
super().is_valid(raise_exception=True)
model = QuerySet(Model).filter(id=self.data.get("id")).first()
if model is None:
raise AppApiException(500, _('Model does not exist'))
if model.permission_type == 'PRIVATE' and str(model.user_id) != str(self.data.get("user_id")):
raise Exception(_('No permission to use this model') + f"{model.name}")
model = QuerySet(Model).get(id=self.data.get('id'))
if model is None:
model = QuerySet(Model).get(id=self.data.get('id'))
return {'id': str(model.id), 'provider': model.provider, 'name': model.name, 'model_type': model.model_type,
'model_name': model.model_name,
'status': model.status,
Copy link
Copy Markdown
Contributor Author

@shaohuzhang1 shaohuzhang1 Apr 2, 2025

Choose a reason for hiding this comment

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

The provided code snippet has a few potential issues and optimizations:

  1. Duplicate if block:

    if model is None:
    model = QuerySet(Model).get(id=self.data.get('id'))

    This duplicated if condition can be removed. It's already covered by the outer if with_valid: .... If with_valid is true, it will have checked for existence earlier.

  2. String comparison efficiency:

    if str(model.user_id) != str(self.data.get("user_id")):

    String comparisons like this should be avoided unless absolutely necessary because they involve type conversion. Instead, you could compare the actual values directly:

    if model.user_id != self.data.get("user_id"):

  3. Code readability:

    • The code uses different spaces between operators (==, !=) which might look inconsistent.
    • Adding consistent spacing can improve readability.

  4. Redundant checks:

    if model is None:
    raise AppApiException(500, _('Model does not exist')

    You don't always need to raise an exception when a model doesn't exist; simply returning None or handling it gracefully might be better depending on its context.

Here’s a revised version of the function with these improvements:

@@ -313,18 +313,21 @@ def one(self, with_valid=False):
             return ModelSerializer.model_to_dict(model)

         def one_meta(self, with_valid=False):
             if with_valid:
                 super().is_valid(raise_exception=True)
                 model_id = self.data.get('id')
                 try:
                     model = Model.objects.filter(id=model_id).first()
                     if not model:
                         raise AppApiException(500, _('Model does not exist'))
                     if model.permission_type == 'PRIVATE' and model.user_id != self.data.get("user_id"):
                         raise Exception(_('No permission to use this model') + f" ({model.name})")
                 except Exception as e:
                     handle_exception(e)
                 model_id = self.data.get('id')
                 
             if isinstance(model_id, int):  # Ensure model_id is an integer
                 model = Model.objects.get(id=model_id)
             else:
                 raise ValueError(_('Invalid model ID'))

             return {
                 'id': str(model.id),
                 'provider': model.provider,
                 'name': model.name,
                 'model_type': model.model_type,
                 'model_name': model.model_name,
                 'status': model.status
             }

Key points:

  • Removed unnecessary duplicate if blocks.
  • Simplified string comparison by avoiding type conversion unless needed.
  • Added additional logic to ensure that self.data['id'] is an integer before calling QuerySet.get().
  • Improved overall code readability and maintainability through consistent formatting and proper separation of concerns.

Expand Down